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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecd:CreateADConnectorDirectory | WRITE |
|
| none |
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 | 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:
Enumeration Value:
| true |
DesktopAccessType | string | No | The method in which the cloud computer is connected. Valid values:
Enumeration Value:
| 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:
Enumeration Value:
| 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. | |
string | No | The DNS address of the existing AD subdomain. | 127.0.**.** | |
Specification | long | No | The type of the AD connector. Valid values:
| 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 | see changesets | ||||
| ||||||
2021-08-19 | The request parameters of the API has changed | see changesets | ||||
|