Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Instances> Creating Cold Storage
Updated on 2023-11-21 GMT+08:00
View PDF

Creating Cold Storage

Function

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

POST 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 tenant 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 cold storage to be created.

The minimum cold storage is 500 GB, and the maximum is 100,000 GB.

is_auto_pay

No

String

Whether the 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 automatic renewal. The 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 cold storage is created for yearly/monthly instances.

Example Requests

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