接口功能介绍
云硬盘快照是一种数据备份方式，可以备份或者恢复整个云硬盘的数据，常用于数据备份、制作镜像、应用容灾等场景。
在回滚云硬盘、更换操作系统、数据迁移等重要操作之前，您可以提前创建快照，从而保存指定时刻的云硬盘数据，提高操作的容错率。
注意：
单个租户下的单个云硬盘在首次创建快照时，会通过订单流程创建，之后的快照不再通过订单流程创建。如果租户主动退订快照订单后，再次创建时仍会通过订单流程创建。
接口约束
1、单个云硬盘支持创建快照个数最多为50个（手动快照最多40个）。
2、快照的地域、加密模式、磁盘模式与源云硬盘需要保持一致。
3、只有“未挂载”和“已挂载”状态的云硬盘才可以创建快照。
4、同一个租户在同一个资源池下创建的快照名称不能重复。
5、磁盘模式为FCSAN或ISCSI的云硬盘不支持创建快照。
接口是否审批
否
URI
POST /v4/ebs_snapshot/create-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。只有通过订单流程创建快照时，clientToken才会保证幂等性。订单流程创建快照场景说明参考接口功能介绍。 | tt-yy-sss | |
| regionID | 是 | String | 资源池ID。 | fc862f71-d629-4a0e-9fe0-b104963b3f05 | |
| snapshotName | 是 | String | 快照名称。仅允许英文字母、数字及_或者-，只能以英文字母开头，且长度为2-63字符。 | snapshot-001 | |
| diskID | 是 | String | 云硬盘ID。 | 36e88a58-1ebf-40ac-91b6-a8c0eca38314 | |
| retentionPolicy | 是 | String | 快照保留策略，取值范围： ●custom：自定义保留天数。 ●forever：永久保留。 | forever | |
| retentionTime | 否 | Integer | 自定义快照保留天数。取值范围：1-65535。当快照保留策略为custom时该参数为必填，当快照保留策略为forever时，自动设置为65535。 | 7 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | 参考响应示例。 | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 参考响应示例。 | |
| returnObj | Object | 返回数据结构体。 | returnObj | |
| details | String | 可忽略。 | 参考响应示例。 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，请参考错误码。 | 参考响应示例。 | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码，请参考错误码。 | 参考响应示例。 | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以ebs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息。 | errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orderID | String | 是否为主订单。 | 参考响应示例。 | |
| resourceType | String | 云硬盘快照资源类型EBS（只有一种）。 | 参考响应示例。 | |
| snapshotName | String | 快照名称。 | 参考响应示例。 | |
| snapshotID | String | 快照ID。 | 参考响应示例。 |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中。 | 参考响应示例。 | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中。 | 参考响应示例。 | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息。 | 参考响应示例。 | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息。 | 参考响应示例。 |
请求示例
请求头header
{
}请求体body
{
"clientToken":"tt-yy-sss",
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"snapshotName":"snapshot-001",
"diskID":"36e88a58-1ebf-40ac-91b6-a8c0eca38314",
"retentionPolicy":"custom",
"retentionTime":7
}响应示例
{
"description" : "订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"errorCode" : "ebs.order.inProgress",
"error": "Ebs.Order.InProgress",
"details": "",
"message" : "order in progress",
"returnObj" : {
"masterOrderID" : "f2533a837273484e93e9bed79f848307",
"masterOrderNO" : "20221110210941194620",
"regionID" : "81f7728662dd11ec810800155d307d5b"
},
"statusCode" : 900
}
或者
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "f2533a837273484e93e9bed79f848307",
"masterResourceID": "a51826820e0b449c8fea9285ee7f4224",
"masterOrderNO": null,
"resources":[{
"orderID": "7ce378d78ff84b47b1eef7ff392ff021",
"snapshotID": "36e88a58-1ebf-40ac-91b6-a8c0eca38314",
"snapshotName": "snapshot-001",
"resourceType": "EBS",
}],
"orderConfig":[{
"masterOrder": True,
"resourceType": "EBS",
"itemConfig": {
"azName": "az1",
"snapshotName": "snapshot-001",
"volumeType": "SATA-SNAP",
"diskID": "36e88a58-1ebf-40ac-91b6-a8c0eca38314",
"billMode": "2"
},
"itemValue": "1"
}],
"cycleType": "ON_DEMAND"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
或者
{
"returnObj": {
"snapshotJobID": "f29d6cbe-6171-11ed-b9da-525400cc3b79"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}状态码
请参考状态码
错误码
请参考错误码
