接口功能介绍
- 扣减资源包创建云电脑。- 根据指定用户ID列表，创建相应数量的云电脑并分配给用户。
接口约束
无
URI
POST /v3/desktop/create
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateOid | 是 | String | 规格模板ID | dft-vfi8ld7okixldvv4xer4p | |
| orgOid | 是 | String | 归属部门ID | org-zotlkju59k15o0j8za84j | |
| imageOid | 是 | String | 镜像ID | mi-p4ij5apxcvse44qid3kec | |
| subnetOid | 是 | String | VPC子网ID | sn-iask4qge5ijil5lbjlz8f | |
| resourcePackOid | 是 | String | 资源包ID | rsp-t4o453t1hs44mr3fqfrj4 | |
| pubUserOidList | 是 | Array of Strings | 用户ID列表，可设置一个或多个，最多50个 | upg-u0hm1u7v8l1nka5ufk5fe | |
| sysDiskType | 是 | String | 系统盘类型（hio-高IO） | hio | |
| sysDiskSize | 是 | Integer | 系统盘大小（单位：GB），需为10的倍数，范围：[max{镜像系统盘大小,80},200] | 80 | |
| dataDiskList | 否 | Array of Objects | 数据盘列表，可设置最多5个 | dataDiskList |
表 dataDiskList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskType | 是 | String | 数据盘类型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）；不同的资源池支持的盘类型可能不同，相关接口：查询可用的磁盘类型列表） | uhio | |
| size | 是 | Integer | 数据盘大小（单位：GB），必须是10的倍数，范围：[10,32000] | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | ok | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| operations | Array of Objects | 创建云电脑操作列表。可用于查询操作状态和新建云电脑ID（相关接口：查询操作列表）。 | operations |
表 operations
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| operationId | String | 操作ID。 | ea98268ebe822d11ae80f63a386e767a | |
| type | String | 操作类型。枚举值范围：Common-通用型;Task-任务型。 | Common |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"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":{"operations":[{"operationId":"32f7211cb74fbb283e42809d2c9a274b","type":"Common"},{"operationId":"abc7211cb74fbb283e42809d2c9a274b","type":"Common"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
