All Products
Search
Document Center

WUYING Workspace:ModifyADConnectorDirectory

Last Updated:Apr 17, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DirectoryIdstringYes

The ID of the directory.

cn-hangzhou+dir-gx2x1dhsmu52rd****
DomainNamestringNo

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. You can register each domain name only once.

example.com
DomainUserNamestringNo

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

sAMAccountName
DomainPasswordstringNo

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

testPassword
DirectoryNamestringNo

The name of the AD directory.

testDirectoryName
SubDomainNamestringNo

The domain name of the existing AD subdomain.

childexample.com
MfaEnabledbooleanNo

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)

false
DnsAddressarrayNo

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.

stringNo

The IP address of the DNS server corresponding to the enterprise AD.

127.0.**.**
SubDomainDnsAddressarrayNo

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.

stringNo

The DNS address of the existing AD subdomain.

127.0.**.**
AdHostnamestringNo

The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.

cnshsv21hmcdc01
OUNamestringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-08-19The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AdHostname
    Added Input Parameters: OUName