Use ListOfficeSiteOverview to query office network overview - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:ListOfficeSiteOverview

get

*All Resource

*

None

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. Valid values: true : false :	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.	cn-hangzhou+dir-363353****
	string	No	The office network ID.	cn-hangzhou+dir-363353****
QueryRange	integer	No	The query scope. Cloud computers in a 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. Valid values: 1 : 2 : 3 :	1

Response elements

Element	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.
	object	Details about the workspace.
OfficeSiteStatus	string	The office network status. Default values: CONFIGUSERFAILED REGISTERING REGISTERED NEEDCONFIGTRUST CONFIGUSERING CONFIGTRUSTFAILED ERROR CONFIGTRUSTING NEEDCONFIGUSER Valid 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 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 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 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 Valid values: standard : customized : basic :	standard
HasExpiredEdsCount	integer	The number of expired cloud computers in the office network.	0
HasExpiredEdsCountForGroup	integer	The number of expired cloud computers in the computer pool.	0
RegionId	string	The ID of the region where the office network resides.	cn-hangzhou

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.