接口功能介绍
- 快照策略功能请联系客户经理开通。
接口约束
无
URI
GET /v3/snapshotPolicy/getDetail
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| snapshotPolicyOid | 是 | String | 快照策略ID | ssp-gg7576hc59fkph1b3xe4y |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotPolicyOid | String | 快照策略ID。 | ssp-gg7576hc59fkph1b3xe4y | |
| snapshotPolicyName | String | 快照策略名称。 | 测oName-1005 | |
| snapshotType | String | 快照类型。枚举值范围：sys-系统盘;data-数据盘;all-系统盘和数据盘。 | sys | |
| snapshotTimePoints | Array of Objects | 快照时间点集合。使用UTC+8时间。时间点格式：HH:mm。 | '00:00','01:00' | snapshotTimePoints |
| cycleType | String | 快照的周期类型。枚举值范围：Week-按周;Day-按天。 | Day | |
| daysOfWeek | Array of Objects | 一个星期中需要快照的天。取值范围[1,7]。只有cycleType取值为Week时有实际意义。 | '1', '7' | daysOfWeek |
| cycleDayCnt | Integer | 快照周期天数。只有cycleType取值为Day时有实际意义。 | 1 | |
| retentionRule | String | 保留规则。枚举值范围：Month-按月;Day-按天;Quantity-按数量;Forever-永久保留。 | Quantity | |
| retentionMonthCnt | Integer | 保留月数。只有retentionRule取值为Month时有实际意义。 | 1 | |
| retentionDayCnt | Integer | 保留天数。只有retentionRule取值为Day时有实际意义。 | 1 | |
| retentionCnt | Integer | 保留数量。只有retentionRule取值为Quantity时有实际意义。 | 4 | |
| autoDelete | Boolean | 是否自动删除。只有retentionRule取值为Quantity时有实际意义。 | false | |
| description | String | 描述。 | ||
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T10:08:11Z |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"snapshotPolicyOid":"ssp-xxx","snapshotPolicyName":"fooName","snapshotType":"sys","snapshotTimePoints":["00:00","01:00"],"cycleType":"Day","cycleDayCnt":30,"retentionRule":"Day","retentionDayCnt":4,"description":"","createTime":"2021-02-24T08:12:43Z"}}
状态码
请参考 状态码
错误码
请参考 错误码
