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

Scaling Up Storage Space

Function

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

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/enlarge-volume

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the DB instance ID.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    volume

    Yes

    Object

    Specifies detailed information about the volume request. For more information, see Table 3.

    Table 3 volume field data structure description

    Name

    Mandatory

    Type

    Description

    group_id

    No

    String

    Specifies the role ID.

    • For a cluster instance, this parameter is set to the ID of the shard group.
    • This parameter is not transferred for replica set instances.

    size

    Yes

    Integer

    Specifies the requested disk capacity. The value must be an integer multiple of 10 and greater than the current storage space.

    • In a cluster instance, this parameter indicates the storage space of shard nodes. The value range is from 10 GB to 2000 GB.
    • In a replica set instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 2000 GB.
  • Request header
    POST https://DDS endpoint/v3/{project_id}/instances/{instance_id}/enlarge-volume
  • Example request
    Clusters:
    {
    	"volume":
    		{
    			"group_id":"1b0c008adbcb495c81a3d5762a02a2abgr02",
    			"size":20
    		}
    }
    Replica sets:
    {
    	"volume":
    		{
    			"size":20
    		}
    }

Responses

  • Parameter description
    Table 4 Parameter description

    Name

    Type

    Description

    job_id

    String

    Indicates the task ID.

  • Response example
    {
        "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
    }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.