Modifies an Active Directory (AD) directory.
Operation description
You can modify the following domain name- and Domain Name System (DNS)-related parameters only for Active Directory (AD) directories that are in the ERROR or REGISTERING state: DomainName
, SubDomainName
, DnsAddress.N
, and SubDomainDnsAddress
.
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 |
DirectoryId | string | Yes | The ID of the directory. | cn-hangzhou+dir-gx2x1dhsmu52rd**** |
DomainName | string | No | The domain name. The name must be 2 to 255 characters in length and must be in the two-part domain name format, such as | example.com |
DomainUserName | string | No | The username of the domain administrator. The username can be up to 64 characters in length. | sAMAccountName |
DomainPassword | string | No | The password of the domain administrator. The username can be up to 64 characters in length. | testPassword |
DirectoryName | string | No | The name of the AD directory. | testDirectoryName |
SubDomainName | string | No | The domain name of the existing AD subdomain. | childexample.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:
| false |
DnsAddress | array | No | 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 | No | The IP address of the DNS server corresponding to the enterprise AD. | 127.0.**.** | |
SubDomainDnsAddress | array | No | The DNS address of the existing AD subdomain. | |
string | No | The DNS address of the existing AD subdomain. | 127.0.**.** | |
AdHostname | string | No | The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows. | cnshsv21hmcdc01 |
OUName | string | No | The name of the organizational unit (OU) in the AD domain. You can call the ListUserAdOrganizationUnits operation to obtain the name of the OU. | example.com/Domain Controllers |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2021-08-19 | The request parameters of the API has changed | see changesets | ||||||
|