All Products
Search
Document Center

WUYING Workspace:CreateADConnectorOfficeSite

Last Updated:Apr 03, 2024

Creates an enterprise Active Directory (AD) office network (formerly workspace). WUYING Workspace supports the following types of accounts: convenience accounts and enterprise AD accounts.

Operation description

When you create an enterprise AD office network, the system automatically creates an AD connector to connect to an enterprise AD. You are charged for the AD connector. For more information, see Billing overview.

After you call this operation to create an AD office network, you must perform the following steps to complete AD domain setting:

  1. Configure a conditional forwarder in a Domain Name System (DNS) server.

  2. Configure a trust relationship in an AD domain controller and call the ConfigADConnectorTrust operation to configure the trust relationship with the AD office network.

  3. Call the ListUserAdOrganizationUnits operation to query a list of organizational units (OUs) of the AD domain, and call the ConfigADConnectorUser operation to specify an OU and administrator for the AD office network.

    Note When you create the AD office network, take note of the DomainUserName and DomainPassword parameters. If you specify the parameters, you need to only configure a conditional forwarder. If you do not specify the parameters, you must configure a conditional forwarder, trust relationship, and OU as prompted.

For more information, see Create and manage enterprise AD office networks.

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
CidrBlockstringYes

The IPv4 CIDR block of the virtual private cloud (VPC) that your office network uses. The system creates a VPC for your office network based on the IPv4 CIDR block. We recommend that you set this parameter to one of the following CIDR blocks and their subnets:

  • 10.0.0.0/12 (subnet mask range: 12 to 24 bits)
  • 172.16.0.0/12 (subnet mask range: 12 to 24 bits)
  • 192.168.0.0/16 (subnet mask range: 16 to 24 bits)
47.100.XX.XX
CenOwnerIdlongNo

The Alibaba Cloud account that creates the Cloud Enterprise Network (CEN) instance.

  • If you do not specify the CenId parameter, or the CEN instance that is specified by the CenId parameter belongs to the current Alibaba Cloud account, skip this parameter.
  • If you specify the CenId parameter and the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, enter the ID of the Alibaba Cloud account.
102681951715****
CenIdstringYes

The ID of the CEN instance.

cen-3gwy16dojz1m65****
VerifyCodestringNo

The verification code. If the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, you must call the SendVerifyCode operation to obtain the verification code.

12****
BandwidthintegerNo

The maximum public bandwidth of the Internet access package. Valid values: 0 to 200.
If you do not specify this parameter or you set this parameter to 0, Internet access is disabled.

1
DomainNamestringYes

The domain name of the enterprise AD system. You can register each domain name only once.

example.com
DomainUserNamestringNo

The username of the domain administrator. The username can be up to 64 characters in length.

Note Specify the username by using sAMAccountName instead of userPrincipalName.
Administrator
DomainPasswordstringNo

The password of the domain administrator. The password can be up to 64 characters in length.

testPassword
OfficeSiteNamestringNo

The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). It must start with a letter and cannot start with http:// or https://.
This parameter is empty by default.

test
EnableAdminAccessbooleanNo

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

Valid values:

  • true

    (default)

  • false

true
DesktopAccessTypestringNo

The method to connect to cloud computers from WUYING clients.

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

Valid values:

  • Internet: connects clients to cloud desktops only over the Internet. [Default]
  • VPC: connects clients to cloud desktops only over a VPC.
  • Any: connects clients to cloud desktops over the Internet or a VPC. You can select a connection method based on your business requirements when you connect to your cloud desktop from a client.
Internet
EnableInternetAccessbooleanNo

Specifies whether to enable Internet access.

true
SubDomainNamestringNo

The domain name of the enterprise AD subdomain.

child.example.com
MfaEnabledbooleanNo

Specifies whether to enable multi-factor authentication (MFA).

false
DnsAddressarrayYes

The IP address of the DNS server of the enterprise AD system. You can specify only one IP address.

stringYes

The IP address of the DNS server of the enterprise AD system. You can specify only one IP address.

192.168.XX.XX
SubDomainDnsAddressarrayNo

The DNS address of the enterprise AD subdomain. If you specify SubDomainName but do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.

stringNo

The DNS address of the enterprise AD subdomain. If you specify SubDomainName but do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.

192.168.XX.XX
SpecificationlongNo

The AD connector type.

Valid values:

  • 1: General

  • 2: Advanced

1
AdHostnamestringNo

The hostname of the domain controller. The hostname must comply with the naming conventions for Windows hosts.

beijing-ad01
ProtocolTypestringNo

The protocol type.

Valid value:

  • Adaptive Streaming Protocol (ASP)

ASP

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSiteIdstring

The office network ID.

cn-hangzhou+dir-363353****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OfficeSiteId": "cn-hangzhou+dir-363353****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-10-28The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Specification
    Added Input Parameters: AdHostname
    Added Input Parameters: ProtocolType
2021-10-28The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: VerifyCode
2021-08-19The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CenOwnerId