启用云主机快照策略
接口功能介绍
启用云主机快照策略
接口约束
- 已启用的快照策略无法再次启用
URI
POST /v4/ecs/snapshot-policy/enable
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
snapshotPolicyID | 是 | String | 云主机快照策略ID,32字节 | 4f69f096066011ee9caf0242ac110002 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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": "4f69f096066011ee9caf0242ac110002"
}
响应示例
{
"returnObj": {
"snapshotPolicyID": "844d5354085211ee81780242ac110005",
"retentionNum": "2",
"snapshotTime": "8",
"snapshotPolicyStatus": 1,
"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.StatusNotValid | 快照策略已经启用 |
Ecs.SnapshotPolicy.EnableError | 启用快照策略失败,请重试。如果多次尝试失败,请提交工单 |