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

Scaling Up Cold Storage

This API is used to scale up cold storage of an instance.

This API can be used only for GeminiDB Influx cluster instances and single-node GeminiDB Influx instances.
This API can be used for 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:updateColdVolume	Write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:modifyStorageSize	-

PUT /v3/{project_id}/instances/{instance_id}/cold-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 Size (GB) of cold storage after scale-up Constraints Select at least 1 GB each time, and the value must be an integer. The maximum cold storage is 100,000 GB. Range N/A Default Value N/A
is_auto_pay	No	String	Definition Whether the order can be paid automatically from your account when you scale up cold storage of your 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 N/A

Status code: 202

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

Scaling up cold data storage space of an instance to 1,000 GB

PUT https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/cold-volume 

{ 
  "size" : 1000 
}

Status code: 202

Accepted

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Instances