查詢快照策略詳情v3
更新時間 2024-06-04 11:13:45
最近更新時間: 2024-06-04 11:13:45
分享文章
接口功能介紹
- 快照策略功能請聯系客戶經理開通。
接口約束
無
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"}}
狀態碼
請參考
錯誤碼
請參考
