Queries the details of workspaces.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOfficeSites

The operation that you want to perform. Set the value to DescribeOfficeSites.

RegionId String Yes cn-hangzhou

The ID of the region.

OfficeSiteType String No SIMPLE

The account type of the workspace. Valid values:

  • SIMPLE: a convenience account
  • AD_CONNECTOR: an enterprise Active Directory (AD) account
MaxResults Integer No 10

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that determines the start point of the next query.

Status String No REGISTERED

The status of the workspace. Valid values:

  • REGISTERING: The workspace is being registered.
  • REGISTERED: The workspace is registered.
  • DEREGISTERING: The workspace is being deregistered.
  • DEREGISTERED: The workspace is deregistered.
  • ERROR: The configuration of the workspace is invalid.
  • NEEDCONFIGTRUST: The trust relationship needs to be configured.
  • NEEDCONFIGUSER: Users need to be configured.
  • CONFIGTRUSTING: The trust relationship is being configured.
  • CONFIGTRUSTFAILED: The trust relationship failed to be configured.
OfficeSiteId.N String No cn-hangzhou+dir-363353****

The ID of workspace N. You can specify one or more workspace IDs.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. If this parameter is empty, all results are returned.

RequestId String F369A091-002F-49C8-AD55-02A776297C7B

The ID of the request.

OfficeSites Array of OfficeSite

The details of workspaces.

Status String REGISTERED

The status of the workspace. The valid values include:

  • REGISTERING: The workspace is being registered.
  • REGISTERED: The workspace is registered.
  • DEREGISTERING: The workspace is being deregistered.
  • DEREGISTERED: The workspace is deregistered.
  • ERROR: The configuration of the workspace is invalid.
  • NEEDCONFIGTRUST: The trust relationship needs to be configured.
  • NEEDCONFIGUSER: Users need to be configured.
  • CONFIGTRUSTING: The trust relationship is being configured.
  • CONFIGTRUSTFAILED: The trust relationship failed to be configured.
CreationTime String 2021-05-06T05:58Z

The time when the workspace was created.

VpcId String vpc-uf6tz5k67puge5jn8****

The ID of the secure office network.

EnableAdminAccess Boolean true

Indicates whether the permissions of the local administrator are granted to the desktop users.

EnableCrossDesktopAccess Boolean false

Indicates whether the desktop communication feature is enabled in the workspace.

After the feature is enabled, the cloud desktops in the same workspace can access each other.

DesktopVpcEndpoint String http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com

The endpoint used to connect to cloud desktops over a virtual private cloud (VPC).

DesktopAccessType String INTERNET

The method that is used to connect to cloud desktops. The valid values include:

  • INTERNET: allows clients to connect to cloud desktops only over the Internet.
  • VPC: allows clients to connect to cloud desktops only over a VPC.
  • ANY: allows clients to connect to cloud desktops over the Internet or a VPC. You can select a connection method when you use clients to connect to the cloud desktops.
DomainName String example.com

The domain name of the enterprise AD system.

SsoEnabled Boolean false

Indicates whether single sign-on (SSO) is enabled.

CidrBlock String 172.16.0.0/16

The IPv4 CIDR block in the secure office network that corresponds to the workspace.

Bandwidth Integer 10

The peak value of the public bandwidth. The valid values include: 0 to 200.

If the value of this parameter is 0, Internet access is disabled.

TrustPassword String 82Tg****

This parameter is unavailable.

Name String test

The name of the workspace. The name is unique within the same region.

EnableInternetAccess Boolean false

Indicates whether Internet access is enabled.

DomainPassword String testPassword

The password of the domain administrator.

CustomSecurityGroupId String sg-bp1ce64o4g9mdf5u****

The ID of the security group.

OuName String example.com/Domain Controllers

The organizational unit (OU) that is connected to the AD domain.

DomainUserName String Administrator

The username of the domain administrator.

SubDomainName String testSubDnsUserName

The username of enterprise AD subdomain.

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

The ID of the workspace.

CenId String cen-3gwy16dojz1m65****

The ID of the Cloud Enterprise Network (CEN) instance.

MfaEnabled Boolean false

Indicates whether multi-factor authentication (MFA) is enabled.

NetworkPackageId String np-amtp8e8q1o9e4****

The ID of the Internet access package.

DnsUserName String testDnsUserName

The username of a Domain Name System (DNS) user.

OfficeSiteType String AD_CONNECTOR

The account type of the workspace. The valid values include:

  • SIMPLE: a convenience account
  • AD_CONNECTOR: an enterprise AD account
ADConnectors Array of ADConnector

The details of AD connectors.

ConnectorStatus String RUNNING

The status of the AD connector. The valid values include:

  • CREATING: The AD connector is being created.
  • CONNECTING: The AD connector is being connected. The AD domain for the connector needs to be configured.
  • RUNNING: The AD connector is running.
  • EXPIRED: The AD connector expired due to overdue payments.
  • CONNECT_ERROR: An connection error occurs.
VSwitchId String vsw-bp19ocz3erfx15uon****

The ID of the vSwitch that corresponds to the network of the AD connector.

ADConnectorAddress String 172.24.*.*

The IP address of the AD connector.

TrustKey String password123***

The trust password that is specified when you configure the AD trust relationship.

NetworkInterfaceId String eni-bp1i4wx78lgosrj6****

The ID of the network interface controller (NIC) that is associated with the AD connector.

Logs Array of Log

The details of registration logs.

Step String CREATE_CONNECTOR

The step that corresponds to the log entry.

Message String code:success | message:Create Connector complete

The message of the log entry.

TimeStamp String 2021-05-12T09:42Z

The time when a log entry was obtained.

Level String INFO

The level of the log entry. The valid values include:

  • INFO
  • ERROR
  • WARN
VSwitchIds Array of String vsw-bp19ocz3erfx15uon****

The IDs of vSwitches.

FileSystemIds Array of String ["05b534****"]

The IDs of Apsara File Storage NAS (NAS) file systems.

SubDnsAddress Array of String ["172.24.*.*"]

The DNS address of the enterprise AD subdomain.

DnsAddress Array of String ["172.24.*.*"]

The DNS address of the AD domain.

NeedVerifyLoginRisk Boolean false

Indicates whether two-step verification for logons is enabled. This parameter is used only for workspaces of the convenience account type.

If two-step verification is enabled, the system checks whether security risks exist within the logon account when a convenience user logs on to the client. If risks are detected, the system sends a verification code to the email address that is associated with the account. In this case, the convenience user can log on to the client only after the verification code is retrieved.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeOfficeSites
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeOfficeSitesResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>
    <OfficeSites>
        <Status>REGISTERED</Status>
        <CreationTime>2021-05-06T05:58Z</CreationTime>
        <VpcId>vpc-uf6tz5k67puge5jn8****</VpcId>
        <EnableAdminAccess>true</EnableAdminAccess>
        <EnableCrossDesktopAccess>false</EnableCrossDesktopAccess>
        <DesktopVpcEndpoint>http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com</DesktopVpcEndpoint>
        <DesktopAccessType>INTERNET</DesktopAccessType>
        <DomainName>example.com    </DomainName>
        <SsoEnabled>false</SsoEnabled>
        <CidrBlock>172.16.0.0/16</CidrBlock>
        <Bandwidth>10</Bandwidth>
        <TrustPassword>82Tg****</TrustPassword>
        <Name>test</Name>
        <EnableInternetAccess>false</EnableInternetAccess>
        <DomainPassword>testPassword</DomainPassword>
        <CustomSecurityGroupId>sg-bp1ce64o4g9mdf5u****</CustomSecurityGroupId>
        <OuName>example.com/Domain Controllers</OuName>
        <DomainUserName>Administrator</DomainUserName>
        <SubDomainName>testSubDnsUserName</SubDomainName>
        <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>
        <CenId>cen-3gwy16dojz1m65****</CenId>
        <MfaEnabled>false</MfaEnabled>
        <NetworkPackageId>np-amtp8e8q1o9e4****</NetworkPackageId>
        <DnsUserName>testDnsUserName    </DnsUserName>
        <OfficeSiteType>AD_CONNECTOR</OfficeSiteType>
        <ADConnectors>
            <ConnectorStatus>RUNNING</ConnectorStatus>
            <VSwitchId>vsw-bp19ocz3erfx15uon****</VSwitchId>
            <ADConnectorAddress>172.24.*.*</ADConnectorAddress>
            <TrustKey>password123***</TrustKey>
            <NetworkInterfaceId>eni-bp1i4wx78lgosrj6****</NetworkInterfaceId>
        </ADConnectors>
        <Logs>
            <Step>CREATE_CONNECTOR</Step>
            <Message>code:success | message:Create Connector complete</Message>
            <TimeStamp>2021-05-12T09:42Z</TimeStamp>
            <Level>INFO</Level>
        </Logs>
        <VSwitchIds>vsw-bp19ocz3erfx15uon****</VSwitchIds>
        <FileSystemIds>["05b534****"]</FileSystemIds>
        <SubDnsAddress> ["172.24.*.*"]</SubDnsAddress>
        <DnsAddress> ["172.24.*.*"]</DnsAddress>
        <NeedVerifyLoginRisk>false</NeedVerifyLoginRisk>
    </OfficeSites>
</DescribeOfficeSitesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "F369A091-002F-49C8-AD55-02A776297C7B",
  "OfficeSites" : [ {
    "Status" : "REGISTERED",
    "CreationTime" : "2021-05-06T05:58Z",
    "VpcId" : "vpc-uf6tz5k67puge5jn8****",
    "EnableAdminAccess" : true,
    "EnableCrossDesktopAccess" : false,
    "DesktopVpcEndpoint" : "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
    "DesktopAccessType" : "INTERNET",
    "DomainName" : "example.com\t",
    "SsoEnabled" : false,
    "CidrBlock" : "172.16.0.0/16",
    "Bandwidth" : 10,
    "TrustPassword" : "82Tg****",
    "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****",
    "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****"
    } ],
    "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.*.*\"]" ],
    "DnsAddress" : [ " [\"172.24.*.*\"]" ],
    "NeedVerifyLoginRisk" : false
  } ]
}