Help Center/ GeminiDB/ API Reference/ API v3/ Instances/ Creating Cold Storage
Updated on 2026-09-22 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 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

Request Parameters

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

Constraints

N/A

Range

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

Default Value

N/A

is_auto_pay

No

String

Definition

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

Range

  • true: The order is automatically paid from the account.
  • false (default value): The order is manually paid from the account.

Default Value

N/A

Response Parameters

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

Range

N/A

Example Requests

Creating 500 GB of cold storage 
POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/4d77eb5d9b9d407d88bbeba254b81aa0in13/cold-volume

{ 
  "size" : 500 
}

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