創建池化桌面池v3
更新時間 2024-06-04 10:58:48
最近更新時間: 2024-06-04 10:58:48
分享文章
接口功能介紹
創建池化桌面池
接口約束
無
URI
POST /v3/commonDesktopPool/create
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 桌面池名稱，只能包含漢字、數字、英文字母、中劃線和下劃線，長度限制1-16個字符 | maxm0926 | |
| orgOid | 是 | String | 歸屬部門ID | org-3fzj92gzwkf9g730m4shf | |
| resourcePackOid | 是 | String | 資源包ID | rsp-a94bn3qnadp0pgiv4mhxo | |
| templateOid | 是 | String | 規格ID，當前僅支持Windows系統的政企版規格（暫不支持GPU規格） | dft-vfi8ld7okixldvv4xer4p | |
| imageOid | 是 | String | 鏡像ID，當前僅支持Windows系統、非GPU鏡像 | mi-p4ij5apxcvse44qid3kec | |
| sysDiskType | 是 | String | 系統盤類型（hio-高IO） | hio | |
| sysDiskSize | 是 | Integer | 系統盤大小（單位：GB），需為10的倍數，范圍：[max{鏡像系統盤大小,80},200] | 80 | |
| subnetOid | 是 | String | 子網ID | sn-w3b8o6cb7afw4l3vd3bgb | |
| desktopCount | 是 | Integer | 云電腦數量，云電腦與用戶數量比例為1:3，至少為1 | 1 | |
| pubUserOidList | 是 | Array of Strings | 用戶ID列表，池化桌面與用戶數量比例為1:3，可設置一個或多個，單次數量上限30 | upg-m611u6q1vm9hekeo5dckl | |
| keepDuration | 否 | Integer | 用戶斷開連接后，云電腦的保留時長（單位：分鐘），至少是3，默認值為3 | 3 | |
| afterReleaseAction | 否 | String | 云電腦釋放后操作（rebuild-還原;stop-關機），默認值為rebuild | rebuild | |
| rebuildAfterStopOrReboot | 否 | String | 關機/重啟后還原系統（on-開啟;off-關閉），默認值為off | off |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回數據結構體。 | returnObj |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{"name":"創建","orgOid":"org-xxx","resourcePackOid":"res-xxx","templateOid":"tem-xxx","imageOid":"mi-xxx","sysDiskType":"hio","sysDiskSize":80,"subnetOid":"sn-xxx","desktopCount":1,"pubUserOidList":["puo-xxx","puo-yyy"],"keepDuration":null,"afterReleaseAction":null,"rebuildAfterStopOrReboot":null}
響應示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
狀態碼
請參考
錯誤碼
請參考
