Updated on 2022-02-22 GMT+08:00

Scaling Up Storage Space of a DB Instance

Function

This API is used to scale up storage space of a DB instance.

Constraints

  • The sizes of the primary and standby DB instances are the same. When you scale the primary DB instance, its standby DB instance is also scaled.
  • The DB instances can be scaled when they are in the Available state.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    enlarge_volume

    Yes

    Object

    Specifies the target storage space after scaling up.

    For details, see Table 3.

    Table 3 enlarge_volume field data structure description

    Name

    Mandatory

    Type

    Description

    size

    Yes

    Integer

    The minimum start value of each scaling is 10 GB. A DB instance can be scaled up only by a multiple of 10 GB. Value range: 40 GB to 4000 GB

  • Request example
    {
    	"enlarge_volume": {
    		"size": 400
       
    	}
    }

Response

  • Pay-per-use
    • Normal response
      Table 4 Parameter description

      Name

      Type

      Description

      job_id

      String

      Indicates the task ID.

    • Example normal response
      {
      	"job_id": "2b414788a6004883a02390e2eb0ea227"
      }
    • Abnormal response

      For details, see Abnormal Request Results.

  • Yearly/Monthly
    • Normal response
      Table 5 Parameter description

      Name

      Type

      Description

      order_id

      String

      Indicates the order ID.

    • Example normal response
      {
      	"order_id": "CS2009151216NO2U2"
      }
    • Abnormal response

      For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.