接口功能介绍
在某个网关下创建某个规格和容量的缓存盘资源
接口约束
1、用户账户下至少有一个状态为运行中的网关，缓存盘创建必须指定某个网关，且指定网关状态为运行中
2、单个网关下最多可以创建4块缓存盘，每次请求限制仅能创建1块缓存盘
3、指定网关下存在缓存盘处于中间状态（部署中、删除中）时，无法创建缓存盘
URI
POST /v4/nfs/create-nfs-cache-disk
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID(目前仅支持华东1资源池) | 参考请求示例 | |
| gatewayID | 是 | String | 网关的ID | 参考请求示例 | |
| orderNumber | 否 | Integer | 缓存盘订购数量，目前默认且仅支持单次请求订购1块缓存盘 | 1 | |
| cacheSpec | 否 | Integer | 缓存盘订购的容量，容量限制为40GB-32TB，默认为40GB，单位为GB | 40 | |
| cacheType | 否 | String | 缓存盘订购类型，①com：通用IO；②high：超高IO，默认为超高IO类型 | ||
| onDemand | 是 | Boolean | 是否按需订购，①false：包周期订购（目前仅支持包周期订购缓存盘资源） | false | |
| cycleType | 否 | String | 包周期类型，onDemand 为 false 时必须指定，①MONTH：月（目前仅支持以月为单位创建） | 参考请求示例 | |
| cycleCount | 否 | Integer | 包周期数，onDemand 为 false 时必须指定，周期最大长度不能超过 36个月 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 响应对象 | 参考表returnObj | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderNO | String | 订单号 | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| masterOrderID | String | 订单ID，调用方在拿到masterOrderID之后，在若干错误情况下，可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"orderNumber":1,
"regionID":"81f7728662dd11ec810800155d307d5b",
"cacheSpec":270,
"gatewayID":"e3b8f598-aba7-11ee-8c8e-18022d1723b2",
"cacheType":"high",
"onDemand":false,
"cycleCount":1,
"cycleType":"MONTH"
}
响应示例
{
"description":"订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"returnObj":{
"masterOrderNO":"20240227170142837007",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"bf4cdeb06bc5464a946d6728aaa68a08"
},
"errorCode":"hsg.order.inProgress",
"details":"",
"error":"Hsg.Order.InProgress",
"message":"order in progress",
"statusCode":900
}
状态码
请参考 状态码
错误码
请参考 错误码
