Updated on 2026-09-22 GMT+08:00

Scaling Instance Storage

This API is used to scale instance storage.

This API supports the following instances:

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

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

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

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
gaussdbfornosql:instance:updateVolume	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:modifyStorageSize	-

PUT /v3/{project_id}/instances/{instance_id}/volume

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
size	Yes	Integer	Definition Requested storage space in GB. The value is an integer. Constraints To scale up storage, ensure the new storage space is greater than the current one. To scale up classic storage, you need to select at least 1 GB each time. The value must be an integer. To scale up cloud native storage, you need to select at least 10 GB each time. The value must be an integer multiple of 10. The target storage after scale-down must exceed 125% of the used storage. The value is rounded up. To scale down classic storage, you need to select at least 1 GB each time. The value must be an integer. To scale down cloud native storage, you need to select at least 100 GB each time. The value must be an integer multiple of 10. Range The maximum and minimum storage space depends on the API type and specifications. For details about GeminiDB Cassandra instances, see Instance Specifications. For details about GeminiDB Redis instances, see Instance Specifications. Default Value N/A
is_auto_pay	No	Boolean	Definition Whether the order is automatically paid from your account when you scale up the storage of a yearly/monthly instance. This parameter does not affect the payment mode of automatic renewal. Constraints N/A Range true: An order is automatically paid from user's account. false: An order is manually paid by a user. The default value is false. Default Value false

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. This parameter is returned only for pay-per-use instances. Range N/A
order_id	String	Definition Order ID. This parameter is returned only when storage space of a yearly/monthly instance is scaled. Range N/A

Changing storage space of an instance to 550 GB

PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume

{
  "size" : 550
}

Status code: 202

Success

Example response for a pay-per-use instance:

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

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Instances