文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 创建冷数据存储
更新时间：2025-05-06 GMT+08:00
查看PDF
分享

创建冷数据存储

功能介绍

创建冷数据存储。

接口约束

  • 该接口仅支持GeminiDB Influx数据库集群实例和GeminiDB Influx数据库单节点实例。
  • 该接口支持包周期和按需实例。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

size

是

Integer

参数解释：

创建的冷数据存储大小，单位：GB。

约束限制：

不涉及。

取值范围：

最小申请规格为500GB，最大申请规格为100000GB。

默认取值：

不涉及。

is_auto_pay

否

String

参数解释：

创建包年/包月实例的冷数据存储时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

约束限制：

不涉及。

取值范围：

  • true，表示自动从账户中支付。
  • false，表示手动从账户中支付，默认为该方式。

默认取值：

不涉及。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。

order_id

String

参数解释：

订单ID，仅创建包年/包月实例的冷数据存储时返回该参数。

取值范围：

不涉及。

请求示例

  • URI样例 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/4d77eb5d9b9d407d88bbeba254b81aa0in13/cold-volume
  • 创建500GB的冷数据存储空间 
    { 
  "size" : 500 
}

响应示例

状态码： 202

Accepted

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理