ListOfficeSiteOverview - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ForceRefresh	boolean	No	Specifies whether to refresh the cache.	false
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100 Default value: 10	10
NextToken	string	No	The token that determines the start point of the next query. If this is your first query or no next query is to be sent, skip this parameter. If a next query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	array	No	The office network IDs. You can specify IDs of 1 to 100 office networks.
	string	No	The office network ID.	cn-hangzhou+dir-363353****
QueryRange	integer	No	The query scope. Cloud computers in a cloud computer pool are pooled cloud computers. Default values: 1 (default): queries non-pooled cloud computers in the office network. 2: queries pooled cloud computers in the office network. 3: queries all cloud computers in the office network.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used to start the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSiteOverviewResults	array<object>	The office network information.
OfficeSiteOverviewResult	object	Details about the workspace.
OfficeSiteStatus	string	The office network status. Default values: CONFIGUSERFAILED REGISTERING REGISTERED NEEDCONFIGTRUST CONFIGUSERING CONFIGTRUSTFAILED ERROR CONFIGTRUSTING NEEDCONFIGUSER	REGISTERED
TotalEdsCount	integer	The total number of cloud computers in the office network.	1
TotalEdsCountForGroup	integer	The total number of cloud computers in the cloud computer pool.	1
WillExpiredEdsCount	integer	The number of cloud computers that are about to expire in the office network.	0
WillExpiredEdsCountForGroup	integer	The number of cloud computers that are about to expire in the cloud computer pool.	0
OfficeSiteId	string	The office network ID.	cn-hangzhou+dir-363353****
RunningEdsCount	integer	The number of cloud computers that are running in the office network.	1
RunningEdsCountForGroup	integer	The number of running cloud computers in the cloud computer pool.	1
OfficeSiteName	string	The office network name.	test
VpcType	string	The office network type and its suitable VPC type. Valid values: standard (default): standard, exclusive VPC customized: custom, user VPC basic: basic, shared VPC	standard
HasExpiredEdsCount	integer	The number of expired cloud computers in the office network.	0
HasExpiredEdsCountForGroup	integer	The number of expired cloud computers in the cloud computer pool.	0
RegionId	string	The ID of the region where the office network resides.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-12-09	The response structure of the API has changed	View Change Details