查詢辦公網絡(原工作區)的概覽信息,包括狀態、云電腦數量、VPC網絡類型等。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以調用 DescribeRegions 獲取無影云電腦支持的地域列表。 | cn-hangzhou |
ForceRefresh | boolean | 否 | 是否刷新緩存。 枚舉值:
| false |
MaxResults | integer | 否 | 分頁查詢時,每頁最大行數。
| 10 |
NextToken | string | 否 | 下一次查詢的令牌(Token)。第一次查詢和沒有下一次查詢時,均無需填寫。如果有下一次查詢,取值為上一次 API 調用返回的 NextToken 值。 | caeba0bbb2be03f84eb48b699f0a4883 |
OfficeSiteId | array | 否 | 辦公網絡 ID。可指定 1~100 個。 | |
string | 否 | 辦公網絡 ID。 | cn-hangzhou+dir-363353**** | |
QueryRange | integer | 否 | 查詢范圍。池化云電腦是指云電腦池(原桌面組)中的云電腦。 枚舉值:
| 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"OfficeSiteOverviewResults": [
{
"OfficeSiteStatus": "REGISTERED",
"TotalEdsCount": 1,
"TotalEdsCountForGroup": 1,
"WillExpiredEdsCount": 0,
"WillExpiredEdsCountForGroup": 0,
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"RunningEdsCount": 1,
"RunningEdsCountForGroup": 1,
"OfficeSiteName": "test",
"VpcType": "standard",
"HasExpiredEdsCount": 0,
"HasExpiredEdsCountForGroup": 0,
"RegionId": "cn-hangzhou"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-04-13 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2021-12-09 | OpenAPI 返回結構發生變更 | 查看變更詳情 |