URI
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/commonDesktopPool/describeUsers
URI参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
desktopPoolOid | string | 是 | 池化桌面池ID |
orgOid | string | 否 | 用户归属部门ID,默认为根部门 |
querySubOrg | boolean | 否 | 是否包含下级部门,默认为是 |
pageNum | int | 否 | 页码,默认1 |
pageSize | int | 否 | 每页数量,默认10,最大100 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
code | int | 状态码 |
msg | string | 返回消息(如有必要) |
data | PageResult | 返回数据对象 |
返回相关类型定义
PageResult
名称 | 类型 | 描述 |
---|---|---|
total | long | 总记录数 |
list | DescribeCommonDesktopPoolUserResult[] | 数据列表 |
DescribeCommonDesktopPoolUserResult
名称 | 类型 | 描述 |
---|---|---|
pubUserOid | string | 用户ID |
userName | string | 用户名 |
loginAccount | string | 登录账户 |
userAccount | string | 用户账户 |
string | 通知邮箱 | |
status | byte | 状态(1-有效,3-待确认) |
示例
请求示例
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/commonDesktopPool/describeUsers?desktopPoolOid=fooId
正常返回示例
{
"code":0,
"data":{
"total":1,
"list":[{
"pubUserOid":"upg-xxx",
"userName":"foo-create-xxx",
"loginAccount":"foo-create-xxx#test",
"userAccount":"foo-create-xxx",
"email":null,
"status":1
}]
}
}