Introduction

Last updated: 2018-06-29

Use the Db2 on Cloud Scaling API to schedule, delete or view the status of a scale operation of your Db2 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

comment: <> (The Db2 on Cloud Scaling REST API is an expansion of the Db2 on Cloud REST API. See the IBM Db2 on Cloud REST API.)

Methods

Scale a service instance.

Scale a service instance to the provided CPU, RAM, and storage values.

Valid ram_gb values are: 4, 8, 16, 32, 64, 128. CPU is scaled together with RAM. Every 4 GB of RAM corresponds to 1 virtual CPU core.

Valid storage_gb values are: 2, 10, 25, 50, 100, 150, 250, 500, 1000, 2000, 4000.

To request the scale operation from the command line instead of by API, use the Cloud Foundry CLI:

cf update-service <service-name> -c '<scale request json>'

where <scale request json> is defined below.

PUT /service_instances/{instance_id}

Request

Path Parameters

  • instance_id
    Required*
    string

    ID of the service instance to scale. This can be obtained from the URL of the instance in IBM Cloud or from the Cloud Foundry CLI by running cf service <service-name> --guid

Request Body

Required*
object

Response

Status Code

  • 202

    Request accepted. Scale will occur asynchronously.

  • 400

    The request was formed improperly.

  • 500

    Internal server error. Please try again later.

No Sample Response

This method does not specify any sample responses.