Scaling Up Storage Space

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

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

**Table 1** Path parameters
Name	Type	IN	Mandatory	Description
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.

**Table 2** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 3** Parameter description
Parameter	Type	Mandatory	Description
volume	Object	Yes	The detailed information about the volume request. For more information, see Table 4.
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 4** Data structure description of the volume field
Parameter	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 a shard node to be scaled up to. Value range: If the shard node has fewer than 8 vCPUs, the value ranges from 10 GB to 5,000 GB. If the shard node has 8 or more vCPUs, the value ranges from 10 GB to 10,000 GB. In a replica set instance, this parameter indicates the storage space of the DB instance to be scaled up to. Value range: If the instance has fewer than 8 vCPUs, the value ranges from 10 GB to 5,000 GB. If the instance has 8 or more vCPUs, the value ranges from 10 GB to 10,000 GB. In a single node instance, this parameter indicates the storage space of the DB instance to be expanded. The value ranges from 10 GB to 5000 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:

 { 
   "volume" : { 
     "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", 
     "size" : 20 
   } 
 }

Replica sets:

 { 
   "volume" : { 
     "size" : 20 
   } 
 }

Single nodes:

 { 
   "volume" : { 
     "size" : 20 
   } 
 }

Read replicas in a replica set instance:

{
"volume" : {
"size" : 20,
"node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ]
}
}

Parameter description

**Table 5** Parameter description
Parameter	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.

Example response

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

For details, see Status Code.

For details, see Error Code.

Parent topic: DB Instance Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.