调用ListOfficeSiteOverview查询工作区的概览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListOfficeSiteOverview

系统规定参数。取值:ListOfficeSiteOverview。

RegionId String cn-hangzhou

地域ID。

ForceRefresh Boolean false

是否刷新缓存。取值范围:

  • true:跳过缓存获取最新数据。
  • false:获取缓存中的数据,可以提升接口性能。
OfficeSiteId.N RepeatList cn-hangzhou+dir-363353****

工作区ID。可指定一个或者多个工作区,最多可以指定100个。

MaxResults Integer 10

分页查询时,每页最大行数。

最大值:100。

默认值:10。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token,NextToken为空表示没有下一个。

OfficeSiteOverviewResults Array of OfficeSiteOverviewResult

工作区信息集合。

HasExpiredEdsCount Integer 0

工作区下已过期的云桌面数量。

OfficeSiteId String cn-hangzhou+dir-363353****

工作区ID。

OfficeSiteName String test

工作区名称。

OfficeSiteStatus String REGISTERED

工作区状态。可能值:

  • REGISTERING:注册中
  • REGISTERED:已注册
RegionId String cn-hangzhou

工作区所属的地域ID。

RunningEdsCount Integer 1

工作区下正在运行中的云桌面数量。

TotalEdsCount Integer 1

工作区下云桌面的总数。

WillExpiredEdsCount Integer 0

工作区下快过期的云桌面数量。

RequestId String EC330A26-1940-4A26-A4C8-E99AE907E25B

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=ListOfficeSiteOverview
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<ListOfficeSiteOverview>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <RequestId>EC330A26-1940-4A26-A4C8-E99AE907E25B</RequestId>
      <OfficeSiteOverviewResults>
            <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>
            <HasExpiredEdsCount>0</HasExpiredEdsCount>
            <TotalEdsCount>1</TotalEdsCount>
            <WillExpiredEdsCount>0</WillExpiredEdsCount>
            <RunningEdsCount>1</RunningEdsCount>
            <OfficeSiteName>test</OfficeSiteName>
            <RegionId>cn-hangzhou</RegionId>
            <OfficeSiteStatus>REGISTERED</OfficeSiteStatus>
      </OfficeSiteOverviewResults>
</ListOfficeSiteOverview>

JSON格式

{
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
	"RequestId": "EC330A26-1940-4A26-A4C8-E99AE907E25B",
	"OfficeSiteOverviewResults": [{
		"OfficeSiteId": "cn-hangzhou+dir-363353****",
		"HasExpiredEdsCount": "0",
		"TotalEdsCount": "1",
		"WillExpiredEdsCount": "0",
		"RunningEdsCount": "1",
		"OfficeSiteName": "test",
		"RegionId": "cn-hangzhou",
		"OfficeSiteStatus": "REGISTERED"
	}]
}