Skip to main contentlogoCreated with Sketch.
  • Start for free

    • Introduction

    Last updated: 2018-07-27

    Use the Db2 Warehouse on Cloud Scaling API to schedule, delete or view the status of a scale operation of your Db2 Warehouse on Cloud instance. Requests require an IBM Cloud UAA token, the space ID of the instance, and the instance ID. The instance and space IDs are available in the URL of the instance on IBM Cloud. The user attempting to make these API calls must also have developer access to the system.

    Error handling

    This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

    Creating a UAA Token

    https://console.bluemix.net/docs/services/cloud-monitoring/security/auth_uaa.html#auth_uaa

    Methods

    Get the last successful or in progress scale request

    GET /scale

    Request

    Query Parameters

    • instanceid
      Required*
      string

      DB2 Warehouse on Cloud Instance ID

    • spaceid
      Required*
      string

      Space ID

    Response

    Response Body

    Get Scale Request

    Status Code

    • 200

      Success

    • 400

      Bad request

    • 500

      Internal error

    No Sample Response

    This method does not specify any sample responses.

    Add a new scale request

    Only one open request is allowed per instance. It is impossible to downsize storagegb once you have scaled up. triggertime must be sent in as epoch time in milliseconds and must be within the next 14 days. storagegb and cpucores must conform to the discrete levels allowed by your specific offering model. If no input is given for triggertime then the start time is now. If there is no input given for storagegb or cpucores then no change will be made to that parameter.

    POST /scale

    Request

    Request Body

    Required*
    User Scale Request

    Request to scale cpu and/or storage

    Response

    Status Code

    • 200

      Success

    • 400

      Bad request

    • 500

      Internal error

    No Sample Response

    This method does not specify any sample responses.

    Deletes a pending scale request

    If a scale request has been started, it cannot be deleted

    DELETE /scale

    Request

    Request Body

    Required*
    Delete Request

    Request to scale cpu and/or storage

    Response

    Status Code

    • 200

      Success

    • 400

      Bad request

    • 500

      Internal error

    No Sample Response

    This method does not specify any sample responses.