接口功能介绍
创建池化桌面池
接口约束
无
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":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
