查詢快照列表v3
更新時間 2024-06-04 11:05:32
最近更新時間: 2024-06-04 11:05:32
分享文章
接口功能介紹
查詢快照列表
接口約束
無
URI
GET /v3/snapshot/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| name | 否 | String | 快照名稱 | API_KZ | |
| snapshotOid | 否 | String | 快照ID | ss-41l5yfe2lg4fdsm4vags5 | |
| desktopOid | 否 | String | 云電腦ID | D0023092701181644 | |
| status | 否 | String | 狀態（Creating-創建中;Active-已激活;Deleting-刪除中;Unhealthy-異常） | Active | |
| pageNum | 否 | Integer | 頁碼，至少1，默認1 | 1 | |
| pageSize | 否 | Integer | 每頁數量，最大100，默認10 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | ||
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| snapshotOid | String | 快照ID | ss-41l5yfe2lg4fdsm4vags5 | |
| name | String | 快照名稱 | API_KZ | |
| desktopOid | String | 云電腦ID | D0023092701181644 | |
| description | String | 描述 | API測試 | |
| type | String | 快照類型，枚舉值范圍：[sys,data,all]（sys-系統盤;data-數據盤;all-系統盤和數據盤） | sys | |
| status | String | 狀態（Creating-創建中;Active-已激活;Deleting-刪除中;Unhealthy-異常） | Active | |
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T08:40:25Z |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"snapshotOid":"ss-foo","name":"foo","desktopOid":"XXXXXXXXXXXXX6925","description":"foo","type":"sys","status":"Active","createTime":"2022-09-25T08:26:29Z"}]}}
狀態碼
請參考
錯誤碼
請參考
