接口功能介绍
- 并发桌面池功能请联系客户经理开通。
接口约束
无
URI
GET /v3/concurrentDesktopPool/describeIncludedDesktops
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| desktopPoolOid | 是 | String | 并发桌面池ID | dp-ybiqd3vedlt5u4cspy6vd | |
| 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 | 总记录数 | ||
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| desktopOid | String | 云电脑ID | D0023092701181644 | |
| desktopName | String | 云电脑名称 | 0000ecae-BxvPeMkJUH | |
| nickname | String | 云电脑别名 | null | |
| osType | String | 操作系统类型（Windows;Linux） | Windows | |
| status | String | 运行状态（Creating-创建中;Stopped-已关机;Starting-启动中;Running-运行中;Rebooting-重启中;Rebuilding-重装中;Stopping-关闭中;Deleting-删除中;Deleted-已删除;Unhealthy-异常;RollingBack-回滚中;Resizing-变更中;Evacuating-迁移中;Rescuing-救援中;BackingUp-备份中;DeletingBackup-删除备份中;Regaining-恢复中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-唤醒中） | Running | |
| flavorType | String | 规格类型。枚举值范围：[Common-通用型, Gpu-GPU型]。 | Common | |
| cpu | Integer | CPU个数 | 4 | |
| memory | Integer | 内存大小（单位：GB） | 8 | |
| gpuMemory | Integer | 显存大小（单位：GB）。仅对GPU规格云电脑有意义。 | 2 | |
| sysDisk | Object | 系统盘 | sysDisk | |
| dataDisks | Array of Objects | 数据盘 | dataDisks | |
| imageOid | String | 镜像ID | mi-xxljp5pe22329w9pp5834 | |
| osName | String | 操作系统名称 | Windows 2016 Standard 64位 中文版（生产） | |
| org | Object | 归属部门 | org | |
| vpcOid | String | VPC ID | vpc-xxdwpyq2jgc62h8fjd2e4 | |
| vpcName | String | VPC名称 | vpc-u9ck | |
| subnets | Array of Objects | 所在子网集合 | subnets | |
| eipAddress | Object | 弹性IP | eipAddress | |
| pubUserOid | String | 分配用户ID（当且仅当用户与云电脑绑定成功时返回） | upg-68xjc1c655mmccohrq1m6 | |
| userName | String | 分配用户名称（当且仅当用户与云电脑绑定成功时返回） | 陆小果 | |
| chargeType | String | 计费方式。枚举值范围：[PrePaid-包年包月, ResourcePack-资源包] | ResourcePack | |
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-27T03:29:10Z | |
| expireTime | String | 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-13T02:34:07Z |
表 sysDisk
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskOid | String | 磁盘ID | vol-38qs2td6q94sge38657ek | |
| diskType | String | 磁盘类型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO） | hio | |
| diskSize | Integer | 磁盘大小。单位：GB | 80 | |
| diskUuid | String | 磁盘UUID | 6b646e82-552f-4be7-aa93-27be0bdf96f3 |
表 dataDisks
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskOid | String | 磁盘ID | vol-38qs2td6q94sge38657ek | |
| diskType | String | 磁盘类型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO） | hio | |
| diskSize | Integer | 磁盘大小。单位：GB | 80 | |
| diskUuid | String | 磁盘UUID | 6b646e82-552f-4be7-aa93-27be0bdf96f3 |
表 org
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orgOid | String | 部门ID | org-18qnu7l41v8fr2xif6jdq | |
| completeOrgName | String | 完整部门名称。由从根部门到当前部门的名称，以半角斜线号（/）为分隔符拼接而成。 | 1026199440@qq.com#贵州测试/API_test |
表 subnets
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| subnetOid | String | 子网ID | sn-59blq3pui5z53da4bmx7i | |
| privateIpAddresses | Array of Objects | 私有IP地址集合 | privateIpAddresses |
表 privateIpAddresses
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| address | String | IP地址 | 192.168.100.174 |
表 eipAddress
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| eipId | String | 弹性IP ID | null | |
| ipAddress | String | IP地址 | null |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"desktopOid":"XXXXXXXXXXXXX6925","desktopName":"desktopName","nickname":"nickname","osType":"Windows","status":"Running","flavorType":"Common","cpu":1,"memory":2,"gpuMemory":2,"org":{"orgOid":"fooId","completeOrgName":"fooRootName/fooName"},"vpcOid":"vpc-xxx","vpcName":"fooName","subnets":[{"subnetOid":"sn-xxx","privateIpAddresses":[{"address":"192.168.1.99"}]}],"sysDisk":{"diskOid":"vol-xxx","diskType":"hio","diskSize":80},"dataDisks":[{"diskOid":"vol-yyy","diskType":"hio","diskSize":10}],"imageOid":"mi-xxx","osName":"Windows 2016 Standard 64位 中文版","pubUserOid":"upg-xxx","userName":"fooName","chargeType":"ResourcePack","createTime":"2099-09-09T00:00:00Z","expireTime":"2099-09-09T00:00:00Z"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
