接口功能介绍
通过接口在指定地域下创建一条自动快照策略。自动快照策略可以周期性地为云硬盘创建自动快照。
接口约束
1、单个用户单个资源池下的策略个数最多为20个;
2、单个用户的单个资源池下策略名称不能重复;
接口是否审批
否
URI
POST /v4/ebs_snapshot/create-policy-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
snapshotPolicyName | 是 | String | 快照策略名称,只能由英文字母、数字、下划线、中划线组成,只能以英文字母开头,长度2-63字符。 | 参考请求示例 | |
repeatWeekdays | 是 | String | 创建快照的重复日期,0-6分别代表周日-周六,多个日期用英文逗号隔开。 | 参考请求示例 | |
repeatTimes | 是 | String | 创建快照的重复时间,0-23分别代表零点-23点,多个时间用英文逗号隔开。 | 参考请求示例 | |
retentionTime | 是 | Integer | 创建快照的保留时间,输入范围为[-1,1-65535],-1代表永久保留。 | 2 | |
isEnabled | 否 | Boolean | 是否启用策略,默认启用。 | true | |
projectID | 否 | String | 默认为“0” | 参考请求示例 |
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyID | String | 策略ID | 参考响应示例 | |
snapshotPolicyJobResult | String | 任务执行状态 | 参考响应示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d"",
""snapshotPolicyName"":""policy-1"",
""repeatWeekdays"":""0,
1,
2"",
""repeatTimes"":""0,
1,
2,
3"",
""retentionTime"":6
}
响应示例
{
""returnObj"":{
""snapshotPolicyID"":""f29d6cbe-6171-11ed-b9da-525400cc3b79"",
""snapshotPolicyJobResult"":""任务执行成功""
},
""details"":"""",
""message"":""SUCCESS"",
""description"":""成功"",
""statusCode"":800
}
状态码
请参考状态码
错误码
请参考错误码