Creates a workspace of the enterprise AD type.

When you create an Active Directory (AD) workspace, AD connectors that are required to connect to enterprise AD systems are automatically created. You are charged for the AD connectors. For more information, see Billing overview.

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 CreateADConnectorOfficeSite

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

CenId String Yes cen-3gwy16dojz1m65****

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

CidrBlock String Yes 172.16.0.0/12

The IPv4 CIDR block in the secure office network of the workspace. The system creates a virtual private cloud (VPC) based on the specified IPv4 CIDR block. We recommend that you specify the IPv4 CIDR block as 10.0.0.0/12, 172.16.0.0/12, 192.168.0.0/16, or a subnet of these CIDR blocks. If you specify an IPv4 CIDR block of 10.0.0.0/12 or 172.16.0.0/12, the mask is 12 to 24 bits in length. If you specify an IPv4 CIDR block of 192.168.0.0/16, the mask is 16 to 24 bits in length.

DnsAddress.N RepeatList Yes 127.0.*.*

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

DomainName String Yes example.com

The domain name of the enterprise AD system. Each domain name can be registered only once.

DomainPassword String Yes testPassword

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

DomainUserName String Yes Administrator

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

Note Use sAMAccountName as the username of the domain administrator instead of userPrincipalName.
RegionId String Yes cn-hangzhou

The region ID.

Bandwidth Integer No 1

The peak public bandwidth value. Valid values: 0 to 200.

If this parameter is not specified or is set to 0, Internet access is disabled.

OfficeSiteName String No test

The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

This parameter is empty by default.

EnableAdminAccess Boolean No true

Specifies whether to grant the permissions of the local administrator to the desktop users. Default value: true.

DesktopAccessType String No Internet

The method used to connect to cloud desktops. Valid values:

  • Internet: allows clients to connect to cloud desktops only over the Internet.
  • VPC: allows only clients in virtual private clouds (VPCs) to connect to cloud desktops.
  • Any: allows connections over both the Internet and VPC. You can select a connection method when you use a client to connect to a cloud desktop.

Default value: Internet.

Note The VPC connection method is provided by Alibaba Cloud PrivateLink, which is free of charge. When this parameter is set to VPC or Any, PrivateLink is automatically activated.
EnableInternetAccess Boolean No true

Specifies whether to enable Internet access.

SubDomainDnsAddress.N RepeatList No 127.0.*.*

The DNS address of enterprise AD subdomain N. If you configured the SubDomainName parameter and leave this parameter empty, the DNS address of the subdomain is considered to be the same as that of the parent domain.

SubDomainName String No childexample.com

The domain name of the enterprise AD subdomain.

MfaEnabled Boolean No false

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

Response parameters

Parameter Type Example Description
OfficeSiteId String cn-hangzhou+dir-363353****

The ID of the workspace.

RequestId String 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=CreateADConnectorOfficeSite
&CenId=cen-3gwy16dojz1m65****
&CidrBlock=172.16.0.0/12
&DnsAddress.1=127.0.*.*
&DomainName=example.com
&DomainPassword=testPassword
&DomainUserName=Administrator
&RegionId=cn-hangzhou
&<Common request parameters>|

Sample success responses

XML format

<CreateADConnectorOfficeSite>
      <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>
      <RequestId>3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF</RequestId>
</CreateADConnectorOfficeSite>

JSON format

{
	"OfficeSiteId": "cn-hangzhou+dir-363353****",
	"RequestId": "3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF"
}