接口功能介绍
- 并发桌面池功能请联系客户经理开通。
接口约束
无
URI
GET /v3/concurrentDesktopPool/describeUsers
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
desktopPoolOid | 是 | String | 并发桌面池ID | dp-w8djg4dwv35w4c19o932g | |
orgOid | 否 | String | 用户归属部门ID,默认为根部门 | null | |
querySubOrg | 否 | Boolean | 是否包含下级部门,默认为是 | true | |
pageNum | 否 | Integer | 页码,默认1 | 1 | |
pageSize | 否 | Integer | 每页数量,默认10,最大100 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK. | |
returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Long | 总记录数 | 1 | |
list | Array of Objects | 数据列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pubUserOid | String | 用户ID | upg-ao6ve5mlakw01xk1c2no5 | |
userName | String | 用户名 | xindyh | |
loginAccount | String | 登录账户 | xindyh#3803 | |
userAccount | String | 用户账户 | xindyh | |
String | 通知邮箱 | 403846933@qq.com | ||
status | Byte | 状态(1-有效,3-待确认) | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"pubUserOid":"upg-xxx","userName":"foo-create-xxx","loginAccount":"foo-create-xxx#test","userAccount":"foo-create-xxx","status":1}]}}
状态码
请参考 状态码
错误码
请参考 错误码