修改快照策略v3
更新時間 2024-06-04 11:13:46
最近更新時間: 2024-06-04 11:13:46
分享文章
接口功能介紹
- 快照策略功能請聯系客戶經理開通。- 快照策略僅支持資源包來源的云電腦（即不支持單實例來源的云電腦）。- 如果云電腦已存在快照，且上一個快照時間點到執行周期時一直關機，則不自動創建快照，當用戶開機后且到下一個執行周期，再創建快照。
接口約束
無
URI
POST /v3/snapshotPolicy/modify
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| snapshotPolicyOid | 是 | String | 快照策略ID。 | ssp-zf13as8ds7ccqb86z8s57 | |
| snapshotPolicyName | 是 | String | 快照策略名稱。只能包含中文、數字、英文字母、下劃線、中劃線，長度限制1-64個字符。 | AS-116 | |
| snapshotType | 是 | String | 快照類型。枚舉值范圍：sys-系統盤;data-數據盤;all-系統盤和數據盤，其中data和all是數據盤相關的快照類型，請聯系客戶經理開通。 | sys | |
| snapshotTimePoints | 是 | Array of Strings | 快照時間點集合。使用UTC+8時間。任意2個時間差必須大于等于1小時。時間點數量范圍[1,24]。時間點格式：HH:mm。 | ||
| cycleType | 是 | String | 快照的周期類型。枚舉值范圍：Week-按周;Day-按天。 | Day | |
| daysOfWeek | 否 | Array of Strings | 一個星期中需要快照的天。快照周期為按周時必填。取值范圍[1,7]，數量限制[1,7]，不允許重復值。 | [2,7] | |
| cycleDayCnt | 否 | Integer | 快照周期天數。快照周期為按天時必填。取值范圍[1,10000]。 | 3 | |
| retentionRule | 是 | String | 保留規則。枚舉值范圍：Month-按月;Day-按天;Quantity-按數量;Forever-永久保留。 | Day | |
| retentionMonthCnt | 否 | Integer | 保留月數。retentionRule為Month時必填。取值范圍[1,12]。 | 2 | |
| retentionDayCnt | 否 | Integer | 保留天數。retentionRule為Day時必填。取值范圍[1,99999]。 | 1 | |
| retentionCnt | 否 | Integer | 保留數量。retentionRule為Quantity時必填。取值范圍[1,99999]。 | 4 | |
| autoDelete | 否 | Boolean | 是否自動刪除。retentionRule為Quantity時需要填寫，默認為true。 | autoDelete | |
| description | 是 | String | 描述。字符數限制[0,254]。 | 0 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回數據結構體。 | returnObj |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{"snapshotPolicyOid":"ssp-xxx","snapshotPolicyName":"fooName","snapshotType":"sys","snapshotTimePoints":["00:00","01:00"],"cycleType":"Day","daysOfWeek":null,"cycleDayCnt":3,"retentionRule":"Day","retentionMonthCnt":null,"retentionDayCnt":4,"retentionCnt":null,"autoDelete":false,"description":""}
響應示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
狀態碼
請參考
錯誤碼
請參考
