All Products
Search

This Product

    WUYING Workspace:DescribeOfficeSites

    Document Center

    WUYING Workspace:DescribeOfficeSites

    Last Updated:Apr 18, 2024

    Queries office network (formerly workspace) properties, including office network ID, name, status, and creation time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    OfficeSiteTypestringNo

    The account type of the office network.

    Valid values:

    • SIMPLE: convenience account

    • AD_CONNECTOR: enterprise Active Directory (AD) account

    		SIMPLE
    MaxResultsintegerNo

    The number of entries to return on each page.

    • Maximum value: 100.
    • Default value: 10.
    		10
    NextTokenstringNo

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

    		caeba0bbb2be03f84eb48b699f0a4883
    OfficeSiteIdarrayNo

    The office network IDs. You can specify the IDs of 1 to 100 office networks.

    stringNo

    The office network ID.

    		cn-hangzhou+dir-363353****
    StatusstringNo

    The office network status.

    Valid values:

    • REGISTERING: The office network is being registered.

    • DEREGISTERING: The office network is being deregistered.

    • REGISTERED: The office network is registered.

    • NEEDCONFIGTRUST: A trust relationship is required for the office network.

    • CONFIGTRUSTFAILED: A trust relationship fails to be configured for the office network.

    • DEREGISTERED: The office network is deregistered.

    • ERROR: One or more configurations of the office network are invalid.

    • CONFIGTRUSTING: A trust relationship is being configured for the office network.

    • NEEDCONFIGUSER: Users are required for the office network.

    		REGISTERED

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    NextTokenstring

    The token that determines the start point of the next query. If this parameter is empty, all results are returned.

    		caeba0bbb2be03f84eb48b699f0a4883
    RequestIdstring

    The ID of the request.

    		1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    OfficeSitesobject []

    The information about office networks.

    Statusstring

    The office network status.

    Valid values:

    • REGISTERING: The office network is being registered.

    • DEREGISTERING: The office network is being deregistered.

    • REGISTERED: The office network is registered.

    • NEEDCONFIGTRUST: A trust relationship is required for the office network.

    • CONFIGTRUSTFAILED: A trust relationship fails to be configured for the office network.

    • DEREGISTERED: The office network is deregistered.

    • ERROR: One or more configurations of the office network are invalid.

    • CONFIGTRUSTING: A trust relationship is being configured for the office network.

    • NEEDCONFIGUSER: Users are required for the office network.

    		REGISTERED
    CreationTimestring

    The time when the office network was created.

    		2021-05-06T05:58Z
    VpcIdstring

    The VPC ID.

    		vpc-uf6tz5k67puge5jn8****
    VpcTypestring

    The VPC type.

    Valid values:

    • Basic

    • Customized

    • Standard

    		Basic
    EnableAdminAccessboolean

    Indicates whether the local administrator permissions are granted to users that are authorized to use cloud computers in the office network.

    Valid values:

    • true (default)
    • false
    		true
    EnableCrossDesktopAccessboolean

    Indicates whether the connection between cloud computers in the office network is enabled. After you enable the connection between cloud computers in the office network, cloud computers in the office network can access each other.

    		false
    DesktopVpcEndpointstring

    The endpoint that is used by the VPC, over which cloud computers are connected.

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

    The method that is used to connect cloud computers that reside in the office network from WUYING clients.

    Note The VPC connection depends on Alibaba Cloud PrivateLink. You can use Alibaba Cloud PrivateLink for free. When you set this parameter to VPC or Any, PrivateLink is automatically activated.

    Valid values:

    • INTERNET (default): Cloud computers are connected from WUYING clients over the Internet.
    • VPC: Cloud computers are connected from WUYING clients over the VPC.
    • ANY: Cloud computers are connected from WUYING clients over the Internet or the VPC. When you use can choose a method to connect cloud computers over the Internet or VPC from WUYING clients based on their business requirements.
    		INTERNET
    DomainNamestring

    The domain name of the enterprise AD.

    		example.com
    SsoEnabledboolean

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

    		false
    CidrBlockstring

    The IPv4 CIDR block of the VPC that the office network uses.

    		172.16.0.0/16
    Bandwidthinteger

    The maximum public bandwidth value. Valid values: 0 to 1000.
    If you leave this parameter empty or set this parameter to 0, Internet access is not enabled.

    		10
    TrustPasswordstring
    Note This parameter is unavailable.
    		null
    Namestring

    The office network name. The name is unique in a region.

    		test
    EnableInternetAccessboolean

    Indicates whether Internet access is enabled.

    		false
    DomainPasswordstring

    The password of the domain administrator.

    		testPassword
    CustomSecurityGroupIdstring

    The security group ID.

    		sg-bp1ce64o4g9mdf5u****
    OuNamestring

    The organizational unit (OU) in the AD domain to which the office network is connected.

    		example.com/Domain Controllers
    DomainUserNamestring

    The username of the domain administrator.

    		Administrator
    SubDomainNamestring

    The username of enterprise AD subdomain.

    		testSubDnsUserName
    OfficeSiteIdstring

    The office network ID.

    		cn-hangzhou+dir-363353****
    CenIdstring

    The CEN instance ID.

    		cen-3gwy16dojz1m65****
    CenAttachStatusstring

    The CEN instance status.

    		attached
    MfaEnabledboolean

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

    		false
    NetworkPackageIdstring

    The premium bandwidth plan ID.

    		np-amtp8e8q1o9e4****
    DnsUserNamestring

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

    		testDnsUserName
    OfficeSiteTypestring

    The account type of the office network.

    Valid values:

    • SIMPLE: convenience account

    • AD_CONNECTOR: enterprise AD account

    		AD_CONNECTOR
    ADConnectorsobject []

    The details of AD connectors.

    ConnectorStatusstring

    The status of the AD connector.

    Valid values:

    • CONNECT_ERROR

    • RUNNING

    • CONNECTING

      (You must configure the AD domain in which the AD connector is used.)

    • EXPIRED

    • CREATING

    		RUNNING
    VSwitchIdstring

    The ID of the vSwitch that resides in the network of the AD connector.

    		vsw-bp19ocz3erfx15uon****
    ADConnectorAddressstring

    The connection address of the AD connector.

    		172.24.*.*
    TrustKeystring

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

    		password123***
    NetworkInterfaceIdstring

    The ID of an elastic network interface (ENI) to which the AD connector is mounted.

    		eni-bp1i4wx78lgosrj6****
    Specificationstring

    The AD connector type.

    Valid values:

    • 1: General

    • 2: Advanced

    		1
    Logsobject []

    Details about registration logs.

    Stepstring

    The step in the log entry.

    		CREATE_CONNECTOR
    Messagestring

    Details of the log entry.

    		code:success | message:Create Connector complete
    TimeStampstring

    The time when the log entry was printed.

    		2021-05-12T09:42Z
    Levelstring

    The log severity.

    Valid values:

    • ERROR

    • INFO

    • WARN

    		INFO
    VSwitchIdsarray

    An array of VSwitch IDs.

    string

    The vSwitch ID.

    		vsw-bp19ocz3erfx15uon****
    FileSystemIdsarray

    An array of Apsara File Storage NAS (NAS) file system IDs.

    string

    The NAS file system ID.

    		["05b534****"]
    SubDnsAddressarray

    An array of DNS addresses for AD subdomains.

    string

    The DNS address of the AD subdomain.

    		 ["172.24.*.*"]
    DnsAddressarray

    The array of DNS addresses in the AD domains.

    string

    The DNS address of the AD domain.

    		 ["172.24.*.*"]
    NeedVerifyLoginRiskboolean

    Indicates whether two-factor verification is enabled when an end user logs on to a WUYING client. This parameter is required only for convenience office networks. If two-factor verification is enabled, the system checks whether security risks exist within the logon account when the end user uses a convenience user to log on to the client. If risks are detected, the system sends a verification code to the email address that is associated with the account of the convenience user. Then, the end user can log on to the client only when the verification code is correct.

    		false
    DesktopCountlong

    The number of cloud computers that are created.

    		1
    TotalEdsCountlong

    The total number of cloud computers.

    		0
    TotalEdsCountForGrouplong

    The total number of cloud computers in the cloud computer pool (formerly desktop group).

    		0
    NeedVerifyZeroDeviceboolean

    Indicates whether the trusted device verification is enabled.

    Valid values:

    • true

    • false

    		true
    CloudBoxOfficeSiteboolean

    Indicates whether the CloudBox-based office network is created.

    Valid values:

    • true

    • false

    		true
    SsoTypestring
    Note This parameter is unavailable.
    Enumeration Value:
    • SAML: SAML.
    		null
    ProtocolTypestring

    The protocol type.

    Valid values:

    • High-definition Experience (HDX)

    • Adaptive Streaming Protocol (ASP)

    		ASP
    AdHostnamestring

    The hostname of the domain controller. The hostname must comply with Windows hostname naming convention.

    		beijing-ad01
    RdsLicenseStatusstring

    The remote desktop service (RDS) license status.

    		2
    RdsLicenseAddressstring

    The IP address of the RDS license.

    		47.100.XX.XX
    RdsLicenseDomainNamestring

    The domain name of the RDS license.

    		test.com

    Examples

    Sample success responses

    JSONformat

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "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",
      "DomainName": "example.com\t",
      "SsoEnabled": false,
      "CidrBlock": "172.16.0.0/16",
      "Bandwidth": 10,
      "TrustPassword": "null",
      "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.*.*\"]"
      ],
      "DnsAddress": [
        " [\"172.24.*.*\"]"
      ],
      "NeedVerifyLoginRisk": false,
      "DesktopCount": 1,
      "TotalEdsCount": 0,
      "TotalEdsCountForGroup": 0,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "null",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": "2",
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "test.com"
    }
  ]
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-07-12The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2023-06-13The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2023-04-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2021-08-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2021-08-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.
    2021-08-19The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.