查询云主机快照策略详情
接口功能介绍
查询云主机快照策略详情
接口约束
无
URI
GET /v4/ecs/snapshot-policy/details
路径参数
无
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyID | String | 云主机快照策略ID | ||
snapshotPolicyStatus | Integer | 云主机快照策略状态 | ||
snapshotPolicyName | String | 云主机快照策略名称 | ||
snapshotTime | String | 执行快照时间,逗号拼接 | 00:00,01:00 | |
retentionType | String | 云主机快照保留类型 | day | |
retentionDay | String | 云主机快照保留天数,快照保留类型为date时返回,否则为空字符串 | ||
retentionNum | String | 云主机快照保留数量,快照保留类型为num时返回,否则为空字符串 | ||
cycleType | String | 云主机快照周期类型,可选:day(天)、week(周) | ||
cycleDay | Integer | 周期天数,周期类型为day时返回,表示多少天进行快照 | ||
cycleWeek | String | 周期星期,周期类型为week时返回,表示周几进行快照,由逗号拼接,由0~6组成,0表示周日 | ||
resourceCount | Integer | 绑定云主机数量 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyID": "85dd2f06040511ee99c20242ac110005"
}
响应示例
{
"returnObj": {
"retentionType": "num",
"snapshotPolicyStatus": 1,
"retentionDay": "",
"snapshotTime": "00:00",
"cycleDay": "",
"snapshotPolicyName": "api-test",
"cycleWeek": "1",
"snapshotPolicyID": "85dd2f06040511ee99c20242ac110005",
"retentionNum": 1,
"cycleType": "week",
"resourceCount": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.SnapshotPolicy.IDNotValid | 快照策略ID长度应为32字节,请输入有效的快照策略ID |
Ecs.SnapshotPolicy.AccessFailed | 查询快照策略失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.SnapshotPolicy.NotFound | 快照策略查询结果为空,请确认输入的快照策略ID是否有效 |