Scaling Up Storage Space

API Description

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

Constraints

This API supports both yearly/monthly and pay-per-use DB instances.
The storage space of a read replica in a cluster instance cannot be scaled up.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:extendVolume	write	instance	g:EnterpriseProjectId	-	-

URI

URI format
POST /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** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
volume	Object	Yes	Definition The detailed information about the volume request. For more information, see Table 4. Constraints N/A Range N/A Default Value N/A
is_auto_pay	Boolean	No	Definition 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. Constraints N/A Range 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. Default Value false

**Table 4** Data structure description of the volume field
Name	Type	Mandatory	Description
group_id	String	No	Definition The role ID. Constraints This parameter is not specified for replica set instances. Range For a cluster instance, this parameter is set to the ID of the shard group. Default Value N/A
size	String	Yes	Definition The requested disk capacity. The value must be an integer multiple of 10 and greater than the current storage space. Constraints N/A Range In a cluster instance, this parameter indicates the storage space of shard nodes. Value range: 10 GB to 5,000 GB when the shard node has fewer than 8 vCPUs. 10 GB to 10,000 GB when the shard node has 8 or more vCPUs. 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 5,000 GB when the instance has fewer than 8 vCPUs. The value range is from 10 GB to 10,000 GB when the instance has 8 or more vCPUs. 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 1,000 GB. Default Value N/A
node_ids	Array of strings	No	Definition 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. Constraints N/A Range N/A Default Value N/A

Example Request

Scaling up the storage space of a cluster instance to 20 GB

POST //{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
  
 { 
   "volume" : { 
     "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", 
     "size" : 20 
   } 
 }

Scaling up the storage space of a replica set instance to 20 GB

POST //{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
  
 { 
   "volume" : { 
     "size" : 20 
   } 
 }

Scaling up the storage space of a single node instance to 20 GB

POST //{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume 
  
 { 
   "volume" : { 
     "size" : 20 
   } 
 }

Scaling up the storage space of a read replica in a replica set instance to 20 GB

POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume
{
"volume" : {
"size" : 20,
"node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ]
}
}

Response

Parameter description

**Table 5** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	Definition The task ID. Range N/A
order_id	String	No	Definition The order ID. This parameter is returned only when the storage capacity of a yearly/monthly DB instance is expanded. Range N/A

Example Response

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

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.