URI
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/commonDesktopPool/describe
URI参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
poolName | string | 否 | 桌面池名称 |
pageNum | int | 否 | 页码,至少1,默认1 |
pageSize | int | 否 | 每页数量,最大100,默认10 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
code | int | 状态码 |
msg | string | 返回消息(如有必要) |
data | PageResult | 返回数据对象 |
返回相关类型定义
PageResult
名称 | 类型 | 描述 |
---|---|---|
total | long | 总记录数 |
list | DescribeCommonDesktopPoolResult[] | 数据列表 |
DescribeCommonDesktopPoolResult
名称 | 类型 | 描述 |
---|---|---|
desktopPoolOid | string | 桌面池ID |
poolName | string | 桌面池名称 |
desktopCount | int | 桌面池中云电脑数量 |
pubUserCount | int | 授权使用桌面池的终端用户数量 |
vpcOid | string | VPC ID |
vpcName | string | VPC 名称 |
osName | string | 操作系统名称 |
status | string | 状态(Operating-运维中;Running-运行中) |
createTime | string | 创建时间。以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
expireTime | string | 到期时间。以ISO 8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
config | PoolConfig | 桌面池配置策略 |
PoolConfig
名称 | 类型 | 描述 |
---|---|---|
keepDuration | int | 用户断开连接后,云电脑的保留时长(单位:分钟) |
afterReleaseAction | string | 云电脑释放后操作(rebuild-还原;stop-关机) |
rebuildAfterStopOrReboot | string | 关机或重启后还原系统(on-开启;off-关闭) |
示例
请求示例
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/commonDesktopPool/describe?poolName=foo
正常返回示例
{
"code":0,
"data":{
"total":1,
"list":[{
"desktopPoolOid":"dp-xxx",
"poolName":"abc",
"desktopCount":1,
"pubUserCount":2,
"vpcOid":"vpc-xxx",
"vpcName":"foo-name-X4EBM96T",
"osName":"Windows 2016 Standard 64位 中文版",
"status":"Running",
"createTime":"2022-09-08T22:13:00Z",
"expireTime":"2026-01-11T10:27:00Z",
"config":{
"keepDuration":33,
"afterReleaseAction":"rebuild",
"rebuildAfterStopOrReboot":"off"
}
}]
}
}