Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Creating Cold Storage
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Creating Cold Storage

Function

This API is used to create cold storage for 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.

Authorization Information

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:createColdVolume

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:modifyStorageSize

    -

URI

POST /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 tenant 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 in GB of the cold storage to be created.

Constraints:

N/A

Values:

The value ranges from 500 GB to 100,000 GB.

Default value:

N/A

is_auto_pay

No

String

Explanation:

Whether an order is paid automatically from your account when you buy cold storage for a yearly/monthly instance. This parameter does not affect the payment mode of auto-renewal.

Constraints:

N/A

Values:

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

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 cold storage is created for yearly/monthly instances.

Values:

N/A

Example Request

  • URI example 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/4d77eb5d9b9d407d88bbeba254b81aa0in13/cold-volume
  • Creating 500 GB of cold storage 
    { 
  "size" : 500 
}

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