Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Scaling Up Cold Storage
Updated on 2024-08-08 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 supports only GeminiDB Influx cluster and GeminiDB Influx single-node instances.

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

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/cold-volume

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

Size in GB of the new cold storage.

  • You can increase cold storage in increments of 1 GB and ensure that the new cold storage is an integer.
  • The maximum cold storage can be up to 100,000 GB.

is_auto_pay

No

String

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:

  • true, indicating that the order is automatically paid from the account.
  • false, indicating that the order is manually paid from the account. The default value is false.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

order_id

String

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

Example Requests

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

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