Creates an enterprise Active Directory (AD) office network (formerly workspace). Elastic Desktop Service 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:
-
Configure a conditional forwarder in a Domain Name System (DNS) server.
-
Configure a trust relationship in an AD domain controller and call the ConfigADConnectorTrust operation to configure the trust relationship with the AD office network.
-
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
Authorization information
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 |
| CidrBlock | string | Yes | 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:
| 47.100.XX.XX |
| CenOwnerId | long | No | The Alibaba Cloud account that creates the Cloud Enterprise Network (CEN) instance.
| 102681951715**** |
| CenId | string | Yes | The ID of the CEN instance. | cen-3gwy16dojz1m65**** |
| VerifyCode | string | No | 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**** |
| Bandwidth | integer | No | The maximum public bandwidth of the Internet access package. Valid values: 0 to 200. | 1 |
| DomainName | string | Yes | The domain name of the enterprise AD system. You can register each domain name only once. | example.com |
| DomainUserName | string | No | 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 |
| DomainPassword | string | No | The password of the domain administrator. The password can be up to 64 characters in length. | testPassword |
| OfficeSiteName | string | No | 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 | test |
| EnableAdminAccess | boolean | No | Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network. Valid values:
| true |
| DesktopAccessType | string | No | The method to connect to cloud computers from Alibaba Cloud Workspace 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 |
| EnableInternetAccess | boolean | No | Specifies whether to enable Internet access. | true |
| SubDomainName | string | No | The domain name of the enterprise AD subdomain. | child.example.com |
| MfaEnabled | boolean | No | Specifies whether to enable multi-factor authentication (MFA). | false |
| DnsAddress | array | Yes | The IP address of the DNS server of the enterprise AD system. You can specify only one IP address. | |
| string | Yes | The IP address of the DNS server of the enterprise AD system. You can specify only one IP address. | 192.168.XX.XX | |
| SubDomainDnsAddress | array | No | The DNS address of the enterprise AD subdomain. If you specify | |
| string | No | The DNS address of the enterprise AD subdomain. If you specify | 192.168.XX.XX | |
| Specification | long | No | The AD connector type. Valid values:
| 1 |
| AdHostname | string | No | The hostname of the domain controller. The hostname must comply with the naming conventions for Windows hosts. | beijing-ad01 |
| ProtocolType | string | No | The protocol type. Valid value:
| ASP |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2024-06-26 | The request parameters of the API has changed | View Change Details |
| 2021-10-28 | The request parameters of the API has changed | View Change Details |
| 2021-10-28 | The request parameters of the API has changed | View Change Details |
| 2021-08-19 | The request parameters of the API has changed | View Change Details |