創建云電腦v3
更新時間 2025-09-16 17:07:12
最近更新時間: 2025-09-16 17:07:12
分享文章
接口功能介紹
- 創建單獨付費云電腦或扣減資源包創建云電腦。- 根據指定用戶ID列表，創建相應數量的云電腦并分配給用戶。
接口約束
無
URI
POST /v3/desktop/create
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
請求參數
請求頭header參數 無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| billMode | 否 | String | 訂購類型。取值范圍： - Cycle：包周期。 - OnDemand：按需。 - ResBag：資源包。 | ||
| cycleType | 否 | String | 周期類型（僅創建單獨付費云電腦有效）。取值范圍： - Month：按月。（僅訂購類型為包周期類型有效） | ||
| cycleCnt | 否 | Integer | 周期數（僅創建單獨付費云電腦有效）。取值范圍： - 1-36。（僅訂購類型為包周期類型有效） | ||
| autoPay | 否 | Boolean | 是否自動支付（僅創建單獨付費云電腦有效），默認false。取值范圍： - true:是。（僅訂購類型為包周期類型有效，需賬號有足夠金額） - false:否。（僅訂購類型為包周期類型有效） | ||
| templateOid | 是 | String | 規格模板ID | ||
| processorType | 否 | String | 處理器類型。創建XC型規格時必填。取值范圍： - kp：鯤鵬。 - hg：海光。 - ft：飛騰。 - zx：兆芯。 - Intel：Intel。 | ||
| orgOid | 否 | String | 歸屬部門ID（僅創建資源包云電腦有效） | ||
| imageOid | 是 | String | 鏡像ID | ||
| subnetOid | 是 | String | VPC子網ID | ||
| resourcePackOid | 否 | String | 資源包ID（僅創建資源包云電腦有效） | ||
| pubUserOidList | 是 | Array of Strings | 用戶ID列表，可設置一個或多個，最多50個 | ||
| sysDiskType | 是 | String | 系統盤類型（hio-高IO） | ||
| sysDiskSize | 是 | Integer | 系統盤大小（單位：GB） - 鏡像系統盤大小（創建單獨付費云電腦，不支持自定義大小） - [max{鏡像系統盤大小,80},200]需為10的倍數（創建資源包云電腦，支持自定義大小） | ||
| dataDiskList | 否 | Array of Objects | 數據盤列表，可設置最多5個 | dataDiskList | |
| 表 dataDiskList |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| diskType | 是 | String | 數據盤類型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）；不同的資源池支持的盤類型可能不同，相關接口：查詢可用的磁盤類型列表） | ||
| size | 是 | Integer | 數據盤大小（單位：GB），必須是10的倍數，范圍：[10,32000] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 | 800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據對象 | returnObj | |
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| newOrderNo | String | 訂單號（僅創建單獨付費云電腦有效）。 | ||
| newOrderId | String | 訂單id（僅創建單獨付費云電腦有效）。 | ||
| totalPrice | String | 總價格（僅創建單獨付費云電腦有效）。 | ||
| operations | Array of Objects | 創建云電腦操作列表。可用于查詢操作狀態和新建云電腦ID（相關接口：查詢操作列表）（僅創建資源包云電腦有效）。 | operations | |
| 表 operations |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| operationId | String | 操作ID。 | ||
| type | String | 操作類型。枚舉值范圍：Common-通用型;Task-任務型。 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{
"billMode":"Cycle",
"cycleType":3,
"cycleCnt":1,
"templateOid":"tem-xxx",
"orgOid":"org-xxx",
"imageOid":"mi-xxx",
"subnetOid":"sn-xxx",
"resourcePackOid":"res-xxx",
"pubUserOidList":["upg-xxx","upg-xxx"],
"sysDiskType":"hio",
"sysDiskSize":80,
"dataDiskList":[{
"diskType":"uhio",
"size":10
},{
"diskType":"uhio",
"size":20
}]
}
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"newOrderNo":20250718141255003733,
"newOrderId":"29471d1d08694681ad87ebf95e29e71a",
"totalPrice":95.1,
"operations":[{
"operationId":"32f7211cb74fbb283e42809d2c9a274b",
"type":"Common"
},{
"operationId":"abc7211cb74fbb283e42809d2c9a274b",
"type":"Common"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
