DescribeOfficeSites - Query office network details - Elastic Desktop Service

Queries all properties of office networks, including ID, name, status, and creation time.

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:DescribeOfficeSites

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to query supported regions.	cn-hangzhou
OfficeSiteType	string	No	The type of account for the office network. Valid values: SIMPLE : convenience account AD_CONNECTOR : enterprise Active Directory (AD) account	SIMPLE
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token used to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	array	No	The office network IDs. You can specify 1 to 100 IDs.	cn-hangzhou+dir-363353****
	string	No	The office network ID.	cn-hangzhou+dir-363353****
Status	string	No	The office network status. Valid values: REGISTERING : Registering DEREGISTERING : Deregistering REGISTERED : Registered NEEDCONFIGTRUST : Requires trust relationship configuration CONFIGTRUSTFAILED : Trust relationship configuration failed DEREGISTERED : Deregistered ERROR : Configuration error CONFIGTRUSTING : Configuring trust relationship NEEDCONFIGUSER : User configuration required	REGISTERED
SecurityProtection	string	No	The security protection setting for the office network. Valid values: SASE : SASE OFF : Off	SASE
VpcId	string	No	The VPC ID.
AccountType	string	No

Response elements

Element	Type	Description	Example
	object	The response.
NextToken	string	The token for the next page. Empty if all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of entries returned.	20
OfficeSites	array<object>	A list of office networks.
	array<object>	An office network.
Status	string	The status of the office network. Valid values: REGISTERING : Registering DEREGISTERING : Deregistering REGISTERED : Registered NEEDCONFIGTRUST : A trust relationship must be configured. CONFIGTRUSTFAILED : Failed to configure the trust relationship. DEREGISTERED : Deregistered ERROR : Error CONFIGTRUSTING : Configuring the trust relationship. NEEDCONFIGUSER : A user must be configured.	REGISTERED
CreationTime	string	The creation time of the office network.	2021-05-06T05:58Z
VpcId	string	The VPC ID of the office network.	vpc-uf6tz5k67puge5jn8****
VpcType	string	The VPC type. Valid values: Basic : Basic Customized : Customized Standard : Standard	Basic
EnableAdminAccess	boolean	Whether local administrator permissions are granted to cloud computer users in the office network. Valid values: true : Grants local administrator permissions (default). false : Does not grant local administrator permissions.	true
EnableCrossDesktopAccess	boolean	Whether cloud computers in the office network can access each other.	false
DesktopVpcEndpoint	string	The VPC endpoint for connecting to cloud computers.	http://ep-bp1s2vmbj55r5rzc**.epsrv-bp1pcfhpwvlpny01**.cn-hangzhou.privatelink.aliyuncs.com
DesktopAccessType	string	The connection method for Elastic Desktop Service clients. Note VPC connections use Alibaba Cloud PrivateLink (free of charge). PrivateLink is enabled when this parameter returns `VPC` or `Any`. Valid values: INTERNET : Internet only (default). VPC : VPC only. ANY : Both internet and VPC. Users select the method on their client.	INTERNET
SsoEnabled	boolean	Whether SSO is enabled.	false
CidrBlock	string	The IPv4 CIDR block of the office network VPC.	47.100.XX.XX
Bandwidth	integer	The peak public bandwidth in Mbit/s. Valid values: 0 to 1000. 0 indicates internet access is disabled.	10
TrustPassword	string	Note This parameter is not available.	To be hidden.
Name	string	The office network name. Must be unique within the region.	test
EnableInternetAccess	boolean	Whether internet access is enabled.	false
DomainPassword	string	The password of the domain administrator.	testPassword
CustomSecurityGroupId	string	The security group ID.	sg-bp1ce64o4g9mdf5u****
OuName	string	The OU in the AD domain.	example.com/Domain Controllers
DomainUserName	string	The username of the domain administrator.	Administrator
SubDomainName	string	The AD subdomain name.	testSubDnsUserName
OfficeSiteId	string	The office network ID.	cn-hangzhou+dir-363353****
CenId	string	The CEN instance ID.	cen-3gwy16dojz1m65****
CenAttachStatus	string	The CEN instance attachment status.	attached
MfaEnabled	boolean	Whether MFA is enabled.	false
NetworkPackageId	string	The ID of the premium bandwidth plan.	np-amtp8e8q1o9e4****
DnsUserName	string	The DNS username.	testDnsUserName
OfficeSiteType	string	The account type of the office network. Valid values: SIMPLE : Convenience account AD_CONNECTOR : Enterprise AD account	AD_CONNECTOR
ADConnectors	array<object>	A list of AD connectors.
	object	An AD connector.
ConnectorStatus	string	The AD connector status. Valid values: CONNECT_ERROR : Connection error RUNNING : Running CONNECTING : Connecting. AD domain configuration is pending. EXPIRED : Expired due to overdue payments CREATING : Creating	RUNNING
VSwitchId	string	The vSwitch ID of the AD connector network.	vsw-bp19ocz3erfx15uon****
ADConnectorAddress	string	The connection address of the AD connector.	172.24..
TrustKey	string	The trust password for the AD trust relationship.	password123***
NetworkInterfaceId	string	The ENI ID of the AD connector.	eni-bp1i4wx78lgosrj6****
Specification	string	The AD connector specification. Valid values: 1 : General 2 : Advanced	1
Logs	array<object>	The registration logs.
	object	A registration log entry.
Step	string	The registration step.	CREATE_CONNECTOR
Message	string	The log message.	code:success \| message:Create Connector complete
TimeStamp	string	The timestamp of the log entry.	2021-05-12T09:42Z
Level	string	The log level. Valid values: ERROR : Error INFO : Info WARN : Warn	INFO
VSwitchIds	array	The vSwitch IDs.
	string	The vSwitch ID.	vsw-bp19ocz3erfx15uon****
FileSystemIds	array	The NAS file system IDs.
	string	The NAS file system ID.	["05b534****"]
SubDnsAddress	array	The DNS addresses of the AD subdomains.
	string	The DNS address of the AD subdomain.	["172.24.XX.XX"]
DnsAddress	array	The DNS addresses of the AD domain.
	string	The DNS address of the AD domain.	["172.24.XX.XX"]
CustomDnsAddress	array	The custom DNS addresses.
	string	The custom DNS address.	["172.24.XX.XX"]
NeedVerifyLoginRisk	boolean	Whether risk-based logon verification is enabled. Applies only to convenience account office networks. When enabled, the system checks for security risks at logon and may require email verification.	false
DesktopCount	integer	The number of individually provisioned cloud computers.	1
TotalEdsCount	integer	The total cloud computer count, including individual and shared.	0
TotalEdsCountForGroup	integer	The number of shared cloud computers.	0
NeedVerifyZeroDevice	boolean	Whether trusted device verification is enabled. Valid values: true : Enabled false : Disabled	true
CloudBoxOfficeSite	boolean	Whether this is a CloudBox-based office network. Valid values: true : CloudBox-based office network. false : Public cloud deployment.	true
SsoType	string	The SSO type. Valid values: SAML : SAML	SAML
ProtocolType	string	The streaming protocol. Valid values: HDX : High-Definition Experience (HDX) protocol ASP : Alibaba Cloud proprietary Adaptive Streaming Protocol (ASP)	ASP
AdHostname	string	The domain controller hostname. Must follow Windows hostname naming conventions.	beijing-ad01
RdsLicenseStatus	string	The RDS license status.	2
RdsLicenseAddress	string	The IP address of the RDS license server.	47.100.XX.XX
RdsLicenseDomainName	string	The domain name of the RDS license server.	example.com
BackupDns	string	The DNS address of the backup domain controller.	172.24.XX.XX
BackupDCHostname	string	The hostname of the backup domain controller.	beijing-ad02
EnableServiceRoute	boolean	Whether cloud service routing access control is enabled.	false
SubnetMode	string	The subnet mode of the office network. Valid values: 0 : The subnet follows the office network mode. 1 : The subnet is in semi-managed mode.	0
SecurityProtection	string	The security protection configuration for the office network. Valid values: SASE : SASE OFF : Off	SASE
CustomAccessPoint	string	The address of the custom access gateway.	gw-****.com
ResourceAmounts	array<object>	A list of resource quantities.
	object
resourceType	string	The resource type. Valid values: desktop : A cloud computer. desktopGroup : A computer pool.	desktop
amount	integer	The number of resources of this type.	1
TotalResourceAmount	integer	The total resource count, including individual and shared cloud computers.	1
NmVersion	string	The network version. The new version supports App Streaming. Valid values: DEFAULT : Old version NM : New version	NM
AcceleratorId	string	The GA instance ID.	ga-bp1astu3yrplkzoo2****
LdapUrl	string
IsLdap	boolean
DomainName	string	The domain name of the enterprise AD.	example.com
AccountType	string
AuthorityHost	string
TenantId	string
ClientId	string
EnvType	string
VplVersion	string
ClientSecret	string
Eid	string
AccessAttribute	string

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 20,
  "OfficeSites": [
    {
      "Status": "REGISTERED",
      "CreationTime": "2021-05-06T05:58Z",
      "VpcId": "vpc-uf6tz5k67puge5jn8****",
      "VpcType": "Basic",
      "EnableAdminAccess": true,
      "EnableCrossDesktopAccess": false,
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "DesktopAccessType": "INTERNET",
      "SsoEnabled": false,
      "CidrBlock": "47.100.XX.XX",
      "Bandwidth": 10,
      "TrustPassword": "To be hidden.",
      "Name": "test",
      "EnableInternetAccess": false,
      "DomainPassword": "testPassword",
      "CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
      "OuName": "example.com/Domain Controllers",
      "DomainUserName": "Administrator",
      "SubDomainName": "testSubDnsUserName",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "CenId": "cen-3gwy16dojz1m65****",
      "CenAttachStatus": "attached",
      "MfaEnabled": false,
      "NetworkPackageId": "np-amtp8e8q1o9e4****",
      "DnsUserName": "testDnsUserName\t",
      "OfficeSiteType": "AD_CONNECTOR",
      "ADConnectors": [
        {
          "ConnectorStatus": "RUNNING",
          "VSwitchId": "vsw-bp19ocz3erfx15uon****",
          "ADConnectorAddress": "172.24.*.*",
          "TrustKey": "password123***",
          "NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****",
          "Specification": "1"
        }
      ],
      "Logs": [
        {
          "Step": "CREATE_CONNECTOR",
          "Message": "code:success | message:Create Connector complete",
          "TimeStamp": "2021-05-12T09:42Z",
          "Level": "INFO"
        }
      ],
      "VSwitchIds": [
        "vsw-bp19ocz3erfx15uon****"
      ],
      "FileSystemIds": [
        "[\"05b534****\"]"
      ],
      "SubDnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "DnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "CustomDnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "NeedVerifyLoginRisk": false,
      "DesktopCount": 1,
      "TotalEdsCount": 0,
      "TotalEdsCountForGroup": 0,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "SAML",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": "2",
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "example.com",
      "BackupDns": "172.24.XX.XX",
      "BackupDCHostname": "beijing-ad02",
      "EnableServiceRoute": false,
      "SubnetMode": "0",
      "SecurityProtection": "SASE",
      "CustomAccessPoint": "gw-****.com",
      "ResourceAmounts": [
        {
          "resourceType": "desktop",
          "amount": 1
        }
      ],
      "TotalResourceAmount": 1,
      "NmVersion": "NM",
      "AcceleratorId": "ga-bp1astu3yrplkzoo2****",
      "LdapUrl": "",
      "IsLdap": false,
      "DomainName": "example.com",
      "AccountType": "",
      "AuthorityHost": "",
      "TenantId": "",
      "ClientId": "",
      "EnvType": "",
      "VplVersion": "",
      "ClientSecret": "",
      "Eid": "",
      "AccessAttribute": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.