接口功能介绍
调用接口为一块或者多块云硬盘关联自动快照策略。关联策略后该云盘会按照策略自动创建自动快照。若云硬盘已经绑定策略,将替换为新的策略。
接口约束
1、单条策略最多关联200个云硬盘;
2、一块云硬盘只能关联一条策略;
3、一条快照策略可以绑定同一资源池下不同可用区的云硬盘,所创建的自动快照与源盘可用区保持一致;
4、磁盘类型为FCSAN、ISCSI的云硬盘不支持关联自动快照策略;
5、快照策略的企业项目需要与所绑定的云硬盘的企业项目保持一致;
6、云硬盘删除后自动和其所关联的策略解绑,不影响策略状态;
7、云硬盘没有快照订单,不支持关联策略;
接口是否审批
否
URI
POST /v4/ebs_snapshot/apply-policy-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
snapshotPolicyID | 是 | String | 要关联的快照策略ID | 参考请求示例 | |
targetDiskIDs | 是 | String | 要关联的云硬盘ID,多个用英文逗号隔开。 | 参考请求示例 |
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中/失败,详见errorCode)。 | 800 | |
message | String | 失败时的错误描述,一般为英文描述。 | 参考响应示例 | |
description | String | 失败时的错误描述,一般为中文描述。 | 参考响应示例 | |
returnObj | Object | 返回数据结构体 | returnObj | |
details | String | 可忽略 | 参考响应示例 | |
errorCode | String | 业务细分码,为product.module.code三段式码。请参考错误码。 | 参考响应示例 | |
error | String | 业务细分码,为product.module.code三段式大驼峰码。请参考错误码。 | 参考响应示例 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyJobResult | String | 任务执行状态 | 参考响应示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d"",
""snapshotPolicyID"":""3641b283-0345-49a9-9c86-bebd963f1caa"",
""targetDiskIDs"":""0ae97ef5-6ee2-44af-9d05-1a509b0a1be6,
0ae97ef5-6ee2-44af-9d05-1a509b0a1be6""
}
响应示例
{
""returnObj"":{
""snapshotPolicyJobResult"":""任务执行成功""
},
""details"":"""",
""message"":""SUCCESS"",
""description"":""成功"",
""statusCode"":800
}
状态码
请参考状态码
错误码
请参考错误码