创建云电脑v3
更新时间 2025-07-29 18:56:01
最近更新时间: 2025-07-29 18:56:01
接口功能介绍
- 创建单独付费云电脑或扣减资源包创建云电脑。- 根据指定用户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 | 是否自动支付（仅创建单独付费云电脑有效）。取值范围： - 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），需为10的倍数，范围：[max{镜像系统盘大小,80},200] | ||
| 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":1,
"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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
