ModifyADConnectorDirectory - Elastic Desktop Service - Alibaba Cloud Documentation Center

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

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

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:
- For mandatory resource types, indicate with a prefix of * .
- 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

Operation	Access level	Resource type	Condition key	Associated operation
ecd:ModifyADConnectorDirectory	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

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`. You can register each domain name only once.	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: true false (default)	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. 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..
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

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object
RequestId	string	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 time	Summary of changes	Operation

Change time	Summary of changes	Operation
2021-08-19	The request parameters of the API has changed	View Change Details