
# 创建冷数据存储 - CreatingColdStorage
#### 功能介绍
创建冷数据存储。
#### 接口约束
- 该接口仅支持GeminiDB Influx数据库集群实例和GeminiDB Influx数据库单节点实例。
- 该接口支持包周期和按需实例。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=CreateColdVolume)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                       | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                      | 别名                               | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:createColdVolume | Write | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | nosql:instance:modifyStorageSize | -      |
     
  
 
#### URI
POST /v3/{project_id}/instances/{instance_id}/cold-volume
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。     |
| instance_id | 是    | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| size        | 是    | Integer | **参数解释：** 创建的冷数据存储大小，单位：GB。 **约束限制：** 不涉及。 **取值范围：** 最小申请规格为500GB，最大申请规格为100000GB。 **默认取值：** 不涉及。                                                                                                                                                                                      |
| is_auto_pay | 否    | String  | **参数解释：** 创建包年/包月实例的冷数据存储时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 **约束限制：** 不涉及。 **取值范围：** - true：表示自动从账户中支付。  - false：表示手动从账户中支付，默认为该方式。   **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 202**
表4响应Body参数 
| 参数       | 参数类型   | 描述                                                                                                                                                    |
|:---|:---|:---|
| job_id   | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。                          |
| order_id | String | **参数解释：** 订单ID，仅创建包年/包月实例的冷数据存储时返回该参数。 **取值范围：** 不涉及。 |
   
#### 请求示例
创建500GB的冷数据存储空间
```
POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/4d77eb5d9b9d407d88bbeba254b81aa0in13/cold-volume
{ 
  "size" : 500 
}
```
#### 响应示例
**状态码： 202**
Accepted
```
{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
