调用ListOfficeSiteOverview查询工作区的概览_无影云电脑企业版(EDS)-阿里云帮助中心

查询办公网络（原工作区）的概览信息，包括状态、云电脑数量、VPC网络类型等。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
ForceRefresh	boolean	否	是否刷新缓存。枚举值： true：跳过缓存获取最新数据。。 false：获取缓存中的数据，可以提升接口性能。。	false
MaxResults	integer	否	分页查询时，每页最大行数。最大值：100。默认值：10。	10
NextToken	string	否	下一次查询的令牌（Token）。第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	array	否	办公网络 ID。可指定 1~100 个。
	string	否	办公网络 ID。	cn-hangzhou+dir-363353****
QueryRange	integer	否	查询范围。池化云电脑是指云电脑池（原桌面组）中的云电脑。枚举值： 1：查询办公网络内的非池化云电脑 [默认值]。 2：查询办公网络内的池化云电脑。 3：查询办公网络下所有云电脑。	1

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSiteOverviewResults	array<object>	办公网络信息集合。
OfficeSiteOverviewResult	object	办公网络信息。
OfficeSiteStatus	string	办公网络状态。枚举值： CONFIGUSERFAILED：配置用户失败。 REGISTERING：注册中。 REGISTERED：已注册。 NEEDCONFIGTRUST：请配置信任关系。 CONFIGUSERING：正在配置用户。 CONFIGTRUSTFAILED：配置信任失败。 ERROR：错误。 CONFIGTRUSTING：正在配置信任关系。 NEEDCONFIGUSER：请配置用户。	REGISTERED
TotalEdsCount	integer	办公网络内云电脑的总数。	1
TotalEdsCountForGroup	integer	云电脑池中的云电脑的总数。	1
WillExpiredEdsCount	integer	办公网络内即将过期的云电脑数量。	0
WillExpiredEdsCountForGroup	integer	云电脑池中即将过期的云电脑数量。	0
OfficeSiteId	string	办公网络 ID。	cn-hangzhou+dir-363353****
RunningEdsCount	integer	办公网络内正在运行中的云电脑数量。	1
RunningEdsCountForGroup	integer	云电脑池中正在运行的云电脑数量。	1
OfficeSiteName	string	办公网络名称。	test
VpcType	string	办公网络 VPC 网络类型。枚举值： standard：标准型办公网络，独占VPC。 [默认值]。 customized：定制型办公网络，用户侧VPC。。 basic：基础型办公网络，共享VPC。。	standard
HasExpiredEdsCount	integer	办公网络内已过期的云电脑数量。	0
HasExpiredEdsCountForGroup	integer	云电脑池中已过期的云电脑数量。	0
RegionId	string	办公网络所属的地域 ID。	cn-hangzhou

示例

正常返回示例

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 返回结构发生变更	查看变更详情