修改云主机快照策略
接口功能介绍
修改云主机快照策略
接口约束
无
URI
POST /v4/ecs/snapshot-policy/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
snapshotPolicyID | 是 | String | 云主机快照策略ID,32字节 | 4f69f096066011ee9caf0242ac110002 | |
snapshotPolicyName | 否 | String | 云主机快照策略名称,长度为2-63字符,由数字、字母、-组成,只能以字母开头,以数字和字母结尾 | update-test01 | |
snapshotTime | 否 | String | 快照整点时间,取值范围0-23,如果一天内多个时间节点备份,以逗号隔开,默认值0 | 12,13 | |
cycleType | 否 | String | 云主机快照周期类型,可选:day(天)、week(周) | week | |
cycleDay | 否 | Integer | 快照周期(天),只有cycleType为day时需设置,范围为[1, 10] | 1 | |
cycleWeek | 否 | String | 快照周期(星期),只有cycleType为week时需设置,取值范围0-6代表星期日-星期六,如果一周有多天备份,以逗号隔开,默认值是0 | 0,2,6 | |
retentionType | 否 | String | 云主机快照保留类型,可选date(按时间保存)、num(按数量保存) | date | |
retentionDay | 否 | Integer | 云主机快照保留时间,retentionType为date时必填,单位为天,范围为[1, 365] | 2 | |
retentionNum | 否 | Integer | 云主机快照保留数量,retentionType为num时必填,范围为[1, 30] | 3 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyStatus | Integer | 状态,0-停用,1-启用 | 1 | |
snapshotPolicyName | String | 策略名称 | test-123 | |
retentionType | String | 快照保留类型 | date | |
retentionDay | String | 保留数量,当retentionType为num时返回,否则为空字符串 | 2 | |
retentionNum | String | 保留数量,当retentionType为num时返回,否则为空字符串 | 2 | |
cycleType | String | 备份周期类型,day-按天备份,week-按星期备份 | day | |
cycleDay | String | 快照周期值,cycleType为day时返回 | 8 | |
cycleWeek | String | 快照周期值,cycleType为week时返回,则取值范围0-6代表星期日-星期六,如果一周有多天备份,以逗号隔开 | 4 | |
snapshotPolicyID | String | 快照策略ID | 03b2d47aa3ae11eda7ae0242ac110009 | |
snapshotTime | String | 快照时间 | 3 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyID": "844d5354085211ee81780242ac110005",
"snapshotPolicyName": "api-create061102",
"snapshotTime": "8",
"cycleType": "day",
"cycleDay": 2,
"retentionType": "num",
"retentionNum": 2
}
响应示例
{
"returnObj": {
"snapshotPolicyID": "844d5354085211ee81780242ac110005",
"retentionNum": "2",
"snapshotTime": "8",
"snapshotPolicyStatus": 0,
"cycleType": "day",
"cycleDay": "2",
"retentionType": "num",
"retentionDay": "",
"snapshotPolicyName": "api-create061102",
"cycleWeek": ""
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.SnapshotPolicy.AccessFailed | 查询快照策略失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.SnapshotPolicy.NotFound | 快照策略查询结果为空,请确认输入的快照策略ID是否有效 |
Ecs.SnapshotPolicy.ExecuteTimeNotValid | [快照执行时间]中含有不在规定[0, 23]区间整数的值,请输入有效的快照执行时间 |
Ecs.SnapshotPolicy.CycleDayNotNull | [云主机快照周期(天数)]不能为空,请输入有效的云主机快照周期(天数) |
Ecs.SnapshotPolicy.CycleDayTypeNotValid | 云主机快照周期(天数)类型错误,请输入有效的云主机快照周期(天数) |
Ecs.SnapshotPolicy.CycleDayScopeNotValid | [云主机快照周期(天数)]不在取值范围[1, 10]内,请输入有效的云主机快照周期(天数) |
Ecs.SnapshotPolicy.CycleWeekNotNull | [云主机快照周期(星期)]不能为空,请输入有效的云主机快照周期(星期) |
Ecs.SnapshotPolicy.CycleWeekNotValid | [云主机快照周期(星期)]有值不在规定列表[0, 1, 2, 3, 4, 5, 6]内,请输入有效的云主机快照周期(星期) |
Ecs.SnapshotPolicy.RetentionDayNotNull | [云主机快照保留天数]不能为空,请输入有效的云主机快照保留天数 |
Ecs.SnapshotPolicy.RetentionDayTypeNotValid | 云主机快照保留天数类型错误,请输入有效的云主机快照保留天数 |
Ecs.SnapshotPolicy.RetentionDayScopeNotValid | [云主机快照保留天数]不在取值范围[1, 365]内,请输入有效的云主机快照保留天数 |
Ecs.SnapshotPolicy.RetentionNumNotNull | [云主机快照保留数量]不能为空,请输入有效的云主机快照保留数量 |
Ecs.SnapshotPolicy.RetentionNumTypeNotValid | 云主机快照保留数量类型错误,请输入有效的云主机快照保留数量 |
Ecs.SnapshotPolicy.RetentionNumScopeNotValid | [云主机快照保留数量]不在取值范围[1, 30]内,请输入有效的云主机快照保留数量 |
Ecs.SnapshotPolicy.NameNotValid | 云主机快照策略名称长度为2-63字符,由数字、字母、-组成,且只能以字母开头,以数字和字母结尾。请输入有效的快照策略名称 |
Ecs.SnapshotPolicy.NameRepeat | 快照策略名称重复,请输入有效的快照策略名称 |
Ecs.SnapshotPolicy.UpdateError | 更新快照策略失败,请重试。如果多次尝试失败,请提交工单 |