查詢池化桌面池列表v3
更新時間 2024-06-04 10:58:46
最近更新時間: 2024-06-04 10:58:46
分享文章
接口功能介紹
查詢池化桌面池列表
接口約束
無
URI
GET /v3/commonDesktopPool/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| poolName | 否 | String | 桌面池名稱 | testtest | |
| 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 | 總記錄數 | 1 | |
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| desktopPoolOid | String | 桌面池ID | dp-2abarbp4482p6b2vxlw3t | |
| poolName | String | 桌面池名稱 | testtest | |
| desktopCount | Integer | 桌面池中云電腦數量 | 1 | |
| pubUserCount | Integer | 授權使用桌面池的終端用戶數量 | 1 | |
| vpcOid | String | VPC ID | vpc-j2cqg2x69mjl4xugi3ape | |
| vpcName | String | VPC 名稱 | maxm0901AA | |
| osName | String | 操作系統名稱 | Windows 2016 Standard 64位 中文版（生產） | |
| status | String | 狀態（Operating-運維中；Running-運行中） | Running | |
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-19T11:26:03Z | |
| expireTime | String | 到期時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-09-29T16:00:00Z | |
| config | Object | 桌面池配置策略 | config |
表 config
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| keepDuration | Integer | 用戶斷開連接后，云電腦的保留時長（單位：分鐘） | 3 | |
| afterReleaseAction | String | 云電腦釋放后操作（rebuild-還原;stop-關機） | rebuild | |
| rebuildAfterStopOrReboot | String | 關機或重啟后還原系統（on-開啟;off-關閉） | on |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{"statusCode":800,"message":"OK.","returnObj":{"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"}}]}}
狀態碼
請參考
錯誤碼
請參考
