接口功能介绍
- 并发桌面池功能请联系客户经理开通。
接口约束
无
URI
GET /v3/concurrentDesktopPool/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| poolName | 否 | String | 桌面池名称 | 按数量 | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | 2 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| desktopPoolOid | String | 桌面池ID | dp-urmb31l1two2so9us14ro | |
| poolName | String | 桌面池名称 | 按数量 | |
| desktopCount | Integer | 桌面池中云电脑数量 | 1 | |
| pubUserCount | Integer | 授权使用桌面池的终端用户数量 | 1 | |
| vpcOid | String | VPC ID | vpc-j2cqg2x69mjl4xugi3ape | |
| vpcName | String | VPC 名称 | maxm0901AA | |
| osName | String | 操作系统名称 | Windows 2016 Standard 64位 中文版（生产） | |
| status | String | 状态（Operating-运维中；Running-运行中） | Running | |
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-21T08:40:03Z | |
| expireTime | String | 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-29T16:00:00Z | |
| config | Object | 桌面池配置策略 | config | |
| concurrentMode | String | 并发模式（Ratio-比例；Quantity-数量） | Quantity | |
| maxConcurrentDesktopCount | Integer | 最大同时在线云电脑数量（并发模式为Quantity时） | 1 | |
| concurrentRate | String | 最大并发比例（并发模式为Ratio时） | null |
表 config
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| keepDuration | Integer | 用户断开桌面连接后，云电脑所占并发额度的保留时长（单位：分钟） | 3 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"desktopPoolOid":"dp-6y2ijfa6466j0kj1fwil2","poolName":"openapi创建并发2MkwQiWV","desktopCount":1,"pubUserCount":0,"vpcOid":"8169e84b36df2b0c27aeb457f4822d8d-vpc-71","vpcName":"foo-name0FSmo2Ll","osName":"Windows 2016 Standard 64位 中文版","status":"Running","createTime":"2022-09-13T12:23:32Z","expireTime":"2026-01-11T02:27:53Z","config":{"keepDuration":3},"concurrentMode":"Ratio","concurrentRate":"0.50"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
