• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v1
  5. DB Instance Management
  6. Changing DB Instance Volume

Changing DB Instance Volume

Function

This API is used to change the DB instance volume.

URI

  • URI format

    PATH: /rds/{versionId}/{project_id}/instances/{instanceId}/action

    Method: POST

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

    Specifies the API version. It is case-sensitive and the value is v1.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the DB instance ID.

  • Restrictions
    1. The adjusted volume size must be greater than the original one and the desired volume size must be a multiple of 10.
    2. 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.
    3. The DB instances can be scaled when they are in the Available state.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    resize

    Dictionary data structure. For details, see Table 3.

    Specifies the information about the request parameter volume.

    Table 3 resize field data structure description

    Name

    Type

    Description

    volume

    Dictionary data structure. For details, see Table 4.

    Specifies the information about the request parameter size.

    Table 4 volume field data structure description

    Name

    Type

    Description

    size

    Int

    Specifies the volume size after scaling up. The value must a multiple of 10.

    Its value range is from 50 GB to 4000 GB.

    NOTICE:

    The adjusted volume size of must be greater than or equal to that of the original volume size.

  • Request example
    {    
    "resize": {
            "volume": {
                "size": 400 
            }
        }
    }

Normal Response

  • Parameter description
    Table 5 Parameter description

    Name

    Type

    Description

    extendparam

    Dictionary data structure. For details, see Table 6.

    Indicates the returned extendparam key-value pair.

    Table 6 extendparam field data structure description

    Name

    Type

    Description

    jobs

    List data structure. For details, see Table 7.

    Indicates the returned jobs parameter information.

    Table 7 jobs field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the task ID.

  • Response example
    {
        "extendparam": {
            "jobs": [
                {
                    "id": "2b414788-a600-4883-a023-90e2eb0ea227"
                }
            ]
        }
    }

Abnormal Response

For details, see Abnormal Request Results.