查詢自定義鏡像列表v3
更新時間 2024-06-04 11:04:49
最近更新時間: 2024-06-04 11:04:49
分享文章
接口功能介紹
查詢自定義鏡像列表
接口約束
無
URI
GET /v3/customImage/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| imageName | 否 | String | 鏡像名稱 | DYF | |
| status | 否 | String | 狀態。枚舉值范圍：[Starting-啟用中, Available-可用, Stopped-停用, StartFailed-啟用失敗, Uploading-上傳中, UploadFailed-上傳失敗, WaitVerify-待驗證, Expired-已過期, Deleting-刪除中, DeleteFailed-刪除失敗]。 | Available | |
| 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 | 總記錄數 | 2 | |
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| imageOid | String | 鏡像ID | mi-lm91642m8ukk1r7a6h7l5 | |
| imageName | String | 鏡像名稱 | Windows-Server-2019-Standard-v1.3 | |
| osType | String | 操作系統類型（Windows;Linux） | Windows | |
| platform | String | 操作系統平臺（Windows;Centos;Ubuntu;UOS;Kylin-銀河麒麟;NeoKylin-中標麒麟） | Windows | |
| sysDisk | Object | 系統盤相關信息 | sysDisk | |
| dataDisks | Array of Objects | 數據盤相關信息列表 | dataDisks | |
| description | String | 描述 | 測試 | |
| gpuCategory | Boolean | 是否為GPU類型鏡像 | false | |
| status | String | 狀態。枚舉值范圍：[Starting-啟用中, Available-可用, Stopped-停用, StartFailed-啟用失敗, Uploading-上傳中, UploadFailed-上傳失敗, WaitVerify-待驗證, Expired-已過期, Deleting-刪除中, DeleteFailed-刪除失敗]。 | Available | |
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T07:48:41Z | |
| expireTime | String | 到期時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | null |
表 sysDisk
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| diskSize | Integer | 盤大小（單位：GB） | 80 |
表 dataDisks
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| diskSize | Integer | 盤大小（單位：GB） | 20 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"imageOid":"mi-xxx","imageName":"xxx","osType":"Windows","platform":"Windows","sysDisk":{"diskSize":80},"dataDisks":[ ],"description":"","gpuCategory":false,"status":"Available","createTime":"2022-03-10T07:04:59Z","expireTime":"2026-01-11T02:27:53Z"}]}}
狀態碼
請參考
錯誤碼
請參考
