切換云電腦鏡像v3
更新時間 2024-06-04 10:44:40
最近更新時間: 2024-06-04 10:44:40
分享文章
接口功能介紹
- 適用于不屬于池化桌面池的云電腦。- 每次切換，云電腦的系統類型、規格類型必須相同。- 新舊鏡像適用的系統類型與規格類型必須相同。
接口約束
無
URI
POST /v3/desktop/batch/changeImage
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 |
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| desktopOidList | 是 | Array of Strings | 云電腦ID列表，可設置一個或多個，最多10個 | D0023092101180485 | |
| imageOid | 是 | String | 鏡像ID | mi-yr404205jf6br4f1dyb03 | |
| includeDataDisk | 否 | Boolean | 切換整機鏡像時，是否包括數據盤，默認為否。 | includeDataDisk |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據結構體。 | { } | returnObj |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{"desktopOidList":["D0023092101180485"],"imageOid":"mi-yr404205jf6br4f1dyb03","includeDataDisk":null}
響應示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
狀態碼
請參考
錯誤碼
請參考
