接口功能介绍
调用接口为某个云硬盘创建快照订单，即开通快照服务。
接口约束
1、磁盘模式为FCSAN，ISCSI的云硬盘不支持开通快照服务；
2、只有可用状态（即未挂载和已挂载状态）的云硬盘才可以开通快照服务；
接口是否审批
否
URI
POST /v4/ebs_snapshot/create-order-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。若不传clientToken 后续将无法准确获取快照服务是否成功开通。 | 参考请求示例 | |
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| diskID | 是 | String | 云硬盘ID | 参考请求示例 |
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为处理中/失败，详见errorCode）。 | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | Object | 返回数据结构体 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码。参考错误码 | 参考响应示例 | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码。参考错误码。 | 参考响应示例 | |
| errorDetail | Object | 错误明细。一般情况下，以ebs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息。 | ||
| details | String | 可忽略 | 参考响应示例 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | 参考响应示例 | |
| masterOrderNO | String | 订单号 | 参考响应示例 | |
| regionID | String | 资源所属资源池ID | 参考响应示例 | |
| masterOrderStatus | String | 快照服务开通状态（成功/失败） | 参考响应示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
"regionID":"41f64827f25f468595ffa3a5deb5d15d",
"diskID":"0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
}
响应示例
{
"returnObj":{
"masterOrderNO":"20221129142256886927",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"42d5cf746fae11ed98d30242ac11000b",
"masterOrderStatus":"开通快照服务成功"
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考状态码
错误码
请参考错误码
