Updated on 2022-12-12 GMT+08:00

Scaling Up Storage Space

API Description

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

Restrictions

This API supports both yearly/monthly and pay-per-use DB instances.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-volume

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge-volume

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    volume

    Object

    Yes

    The detailed information about the volume request.

    For more information, see Table 3.

    is_auto_pay

    Boolean

    No

    Whether the order is automatically paid from your account when you scale up the storage of a yearly/monthly DB instance. This parameter does not affect the payment mode of automatic renewal.

    • true: indicates that the order is automatically paid from the account.
    • false: indicates that the order is manually paid from the account. The default value is false.
    Table 3 Data structure description of the volume field

    Name

    Type

    Mandatory

    Description

    group_id

    String

    No

    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

    String

    Yes

    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 3000 GB.
    • In a single node instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 1000 GB.

    node_ids

    Array of strings

    No

    This parameter is required when the disk capacity of the read replica of a replica set instance is expanded. Only one element can be transferred in the list.

  • Request example
    Clusters:
    POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
      
     { 
       "volume" : { 
         "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", 
         "size" : 20 
       } 
     }
    Replica sets:
    POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
      
     { 
       "volume" : { 
         "size" : 20 
       } 
     }
    
    Single nodes:
    POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
      
     { 
       "volume" : { 
         "size" : 20 
       } 
     }
  • Read replica of a replica set instance.

    POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume

    {

    "volume" : {

    "size" : 20,

    "node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ]

    }

    }

Responses

  • Parameter description
    Table 4 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    The task ID.

    order_id

    String

    No

    The order ID. This parameter is returned only when the storage capacity of a yearly/monthly DB instance is expanded.

  • Response example
    {
         "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
    }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.