You can call the ModifyADInfo operation to modify the information about the Active Directory (AD) domain of an ApsaraDB RDS for SQL Server instance.
This operation is available only for ApsaraDB RDS for SQL Server instances.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | ModifyADInfo |
The operation that you want to perform. Set the value to ModifyADInfo. |
| ClientToken | String | No | ETnLKlblzczshOTUbOCzxxxxxxx |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. |
| DBInstanceId | String | Yes | rm-uf6wjk5xxxxxxx |
The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance. |
| RegionId | String | Yes | cn-hangzhou |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
| ADDNS | String | No | example.com |
The DNS information about the AD domain. |
| ADServerIpAddress | String | No | 47.100.XX.XX |
The IP address of the AD domain. |
| ADAccountName | String | No | test_account |
The account of the AD domain. |
| ADPassword | String | No | test_password |
The password for the account of the AD domain. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=ModifyADInfo
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxx
&DBInstanceId=rm-uf6wjk5xxxxxxx
&RegionId=cn-hangzhou
&ADDNS=100.100.XX.XX
&ADServerIpAddress=192.168.XX.XX
&ADAccountName=test_account
&ADPassword=test_password
&Common request parameters
Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyADInfoResponse>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
</ModifyADInfoResponse>
JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}
Error codes
For a list of error codes, visit the API Error Center.