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.
URI
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/cold-volume
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token Constraints: N/A Values: N/A Default value: N/A |
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 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: Constraints: N/A Values:
Default value: N/A |
Response Parameters
Status code: 202
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 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot