接口功能介绍
查询云硬盘自动快照策略。
接口约束
无
接口是否审批
否
URI
GET /v4/ebs_snapshot/query-policy-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 |
| snapshotPolicyID | 否 | String | 快照策略ID | 参考请求示例 |
| snapshotPolicyName | 否 | String | 快照策略名称 | 参考请求示例 |
请求头header参数
无
请求体body参数
无
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为处理中/失败，详见errorCode）。 | 800 | |
| message | String | 失败时的错误描述，一般为英文描述。 | 参考响应示例 | |
| description | String | 失败时的错误描述，一般为中文描述。 | 参考响应示例 | |
| returnObj | Object | returnObj | returnObj | |
| details | String | 可忽略 | 参考响应示例 | |
| errorCode | String | 业务细分码，为product.module.code三段式码。请参考错误码。 | 参考响应示例 | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码。请参考错误码。 | 参考响应示例 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotPolicyTotalCount | Integer | 自动快照策略总数量 | 10 | |
| snapshotPolicyList | Array of Objects | 自动快照策略列表 | snapshotPolicyList |
表 snapshotPolicyList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotPolicyID | String | 自动快照策略ID | 参考响应示例 | |
| snapshotPolicyName | String | 自动快照策略名称 | 参考响应示例 | |
| snapshotPolicyStatus | String | 自动快照策略状态（activated:启用，deactivated：停用） | 参考请求示例 | |
| repeatWeekdays | String | 创建快照的重复日期，0-6分别代表周日-周六，多个日期用英文逗号隔开。 | 参考请求示例 | |
| repeatTimes | String | 创建快照的重复时间，0-23分别代表零点-23点，多个时间用英文逗号隔开。 | 参考请求示例 | |
| retentionTime | Integer | 创建快照的保留时间，-1代表永久保留。 | 5 | |
| projectID | String | 企业项目 | 参考请求示例 | |
| boundDiskNum | Integer | 关联云硬盘的数量 | 2 | |
| snapshotPolicyCreateTime | String | 策略创建时间 | 参考请求示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d""
}
响应示例
{
""message"": ""SUCCESS"",
""description"": ""成功"",
""statusCode"": 800,
""returnObj"": {
""snapshotPolicyTotalCount"": 1,
""snapshotPolicyList"":
[
{
""snapshotPolicyID"" : ""73f321ea-62ff-11ec-a8bc-005056898fe0"",
""snapshotPolicyName"" : ""ecs001"",
""snapshotPolicyStatus"" : ""activated"",
""repeatWeekdays"" : ""0,1,2"",
""repeatTimes"" : ""0,1,2"",
""retentionDays"" : 6,
""projectID"" : ""0"",
""boundDiskNum"" : 2,
""snapshotPolicyCreateTime"" : ""2022-11-08T11:07:28"",
}
]
}
}
状态码
请参考状态码
错误码
请参考错误码
