Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Scaling Up Cold Storage
Updated on 2025-09-16 GMT+08:00
View PDF
Share

Scaling Up Cold Storage

Function

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

Constraints

  • 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.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a user in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

Explanation:

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.

Values:

N/A

Default value:

N/A

is_auto_pay

No

String

Explanation:

Whether the order can be paid automatically from your account when you scale up cold storage of your instance. This parameter does not affect the payment mode of automatic renewal. The parameter value can be:

Constraints:

N/A

Values:

  • 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

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

Task ID.

Values:

N/A

order_id

String

Explanation:

Order ID. This parameter is returned only when storage space of a yearly/monthly instance is scaled up.

Values:

N/A

Example Request

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/cold-volume
  • Scaling up cold data storage space of an instance to 1,000 GB 
    { 
  "size" : 1000 
}

Example Response

Status code: 202

Accepted

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances