接口功能介绍
- 并发桌面池功能请联系客户经理开通。
接口约束
无
URI
POST /v3/concurrentDesktopPool/create
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 桌面池名称,只能包含汉字、数字、英文字母、中划线和下划线,长度限制1-16个字符 | fooName | |
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),当前只支持80GB | 80 | |
dataDiskList | 否 | Array of Objects | 数据盘列表,可设置最多5个 | dataDiskList | |
subnetOid | 是 | String | 子网ID | sn-w3b8o6cb7afw4l3vd3bgb | |
pubUserOidList | 是 | Array of Strings | 用户ID列表 | upg-m611u6q1vm9hekeo5dckl | |
concurrentMode | 是 | String | 并发模式(Ratio-比例;Quantity-数量) | Ratio | |
keepDuration | 否 | Integer | 用户断开连接后,云电脑所占并发额度的保留时长(单位:分钟),至少是3,默认值为3 | 3 | |
maxConcurrentDesktopCount | 否 | Integer | 最大同时在线云电脑数量(并发方式为Quantity时填),至少是1,默认值为1 | 1 |
表 dataDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskType | 是 | String | 数据盘类型(hio-高IO(high IO);uhio-超高IO(ultra-high IO);不同的资源池支持的盘类型可能不同,相关接口:查询可用的磁盘类型列表) | uhio | |
size | 是 | Integer | 数据盘大小(单位:GB),必须是10的倍数,范围:[10,32000] | 20 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK | |
returnObj | Object | 返回数据结构体。 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"name":"fooName","orgOid":"org-xxx","resourcePackOid":"res-xxx","templateOid":"tem-xxx","imageOid":"mi-xxx","sysDiskType":"hio","sysDiskSize":80,"dataDiskList":[{"diskType":"uhio","size":10},{"diskType":"uhio","size":20}],"subnetOid":"xxx-sn-xxx","pubUserOidList":["puo-xxx"],"concurrentMode":"Ratio","keepDuration":null,"maxConcurrentDesktopCount":null}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码