查詢池化桌面池用戶v3
更新時間 2024-06-04 10:58:50
最近更新時間: 2024-06-04 10:58:50
分享文章
接口功能介紹
查詢池化桌面池用戶
接口約束
無
URI
GET /v3/commonDesktopPool/describeUsers
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| desktopPoolOid | 是 | String | 池化桌面池ID | dp-ucod37vk0gca50kur44j4 | |
| orgOid | 否 | String | 用戶歸屬部門ID，默認為根部門 | org-3fzj92gzwkf9g730m4shf | |
| 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-m611u6q1vm9hekeo5dckl | |
| userName | String | 用戶名 | zizhanghao | |
| loginAccount | String | 登錄賬戶 | zizhanghao#3851 | |
| userAccount | String | 用戶賬戶 | zizhanghao | |
| String | 通知郵箱 | maxm756913@163.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}]}}
狀態碼
請參考
錯誤碼
請參考
