CreateADConnectorDirectory - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a directory of the Active Directory (AD) type.

Operation description

An AD directory is used to connect to an enterprise's existing Active Directory and is suitable for large-scale cloud computer deployment. You are charged directory fees when you connect your AD to cloud computers. For more information, see Billing overview.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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
DomainName	string	Yes	The fully qualified domain name (FQDN) of the enterprise AD system. The value must contain the hostname and the domain name. You can register each FQDN only once.	corp.example.com
DomainUserName	string	Yes	The username of the domain administrator. The username can be up to 64 characters in length.	sAMAccountName
DomainPassword	string	Yes	The password of the domain administrator. The password can be up to 64 characters in length.	testPassword
DirectoryName	string	Yes	The directory name. The name must be 2 to 255 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).	testDirectoryName
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 (default) false Enumeration Value: true: To grant the local administrator permission [Default]. false: Not to grant the local administrator permission.	true
DesktopAccessType	string	No	The method in which the cloud computer is connected. Valid values: VPC Internet (default) Any Enumeration Value: VPC: Only connect through VPC. Internet: Only connect through the Internet [Default]. Any: Both VPC and Internet are supported.	Internet
SubDomainName	string	No	The FQDN of the enterprise AD subdomain. The value must contain the hostname and the subdomain name.	child.example.com
MfaEnabled	boolean	No	Specifies whether to enable Multi-Factor Authentication (MFA). After you enable MFA, all AD users in the directory must enter a dynamic verification code generated by the virtual MFA device in addition to a correct password when they log on to a cloud computer. Note When end users log on to a cloud computer for the first time, they must bind an MFA device. Valid values: true false (default) Enumeration Value: true: To enable MFA. false: To disable MFA [Default].	false
DnsAddress	array	Yes	The IP address of the DNS server corresponding to the enterprise AD. You can specify only one IP address. Make sure that the specified IP address is accessible in the network of the selected vSwitch.
	string	Yes	The IP address of the DNS server corresponding to the enterprise AD.	127.0..
VSwitchId	array	Yes	Details of the vSwitch IDs. You can specify only one vSwitch ID.
	string	Yes	The ID of the vSwitch.	vsw-bp19ocz3erfx15uon****
SubDomainDnsAddress	array	No	The DNS address of the existing AD subdomain. If you specify the `SubDomainName` parameter but you do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.
	string	No	The DNS address of the existing AD subdomain.	127.0..
Specification	long	No	The type of the AD connector. Valid values: 1 (General) 2 (Advanced)	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TrustPassword	string	The AD trust password.	82Tg****
RequestId	string	The ID of the request.	3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF
DirectoryId	string	The ID of the AD directory.	cn-hangzhou+dir-gx2x1dhsmu52rd****
AdConnectors	array<object>	The details of AD connectors.
AdConnector	object	AD Connector.
Address	string	The connection address.	127.0..

Examples

Sample success responses

JSONformat

{
  "TrustPassword": "82Tg****",
  "RequestId": "3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF",
  "DirectoryId": "cn-hangzhou+dir-gx2x1dhsmu52rd****",
  "AdConnectors": [
    {
      "Address": "127.0.**.**"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-11-14	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-08-19	The request parameters of the API has changed	View Change Details