Modifies the AD domain information about an ApsaraDB RDS for SQL Server instance.
Operation description
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 Resourcesis 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 |
|---|---|---|---|---|
| rds:ModifyADInfo | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCzxxxxxxx |
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ADDNS | string | No | The DNS information about the AD domain. | example.com |
| ADServerIpAddress | string | No | The IP address of the AD domain. | 47.100.XX.XX |
| ADAccountName | string | No | The account of the AD domain. | test_account |
| ADPassword | string | No | The password for the account of the AD domain. | test_password |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | EngineVersionNotSupported | The current engineVersion does not support AD operation. | - |
| 400 | InvalidADDNS.NotFound | Specified adDNS is null. | - |
| 400 | InvalidAdServerIpAddress.NotFound | Specified adServer IpAddress is null. | - |
| 400 | InvalidAdAccountName.NotFound | Specified adAccountName is null. | - |
| 400 | InvalidAdPassword.NotFound | Specified adPassword is null. | - |
| 400 | InvalidShareDbInstanceClassNotSupport | The current instance classType does not support this operation. | - |
| 400 | InvalidNodeType.NotSupport | The specified nodeType does not support. | The specified node type is not supported. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||
|---|---|---|---|---|---|---|
| 2023-11-21 | The Error code has changed | see changesets | ||||
| ||||||
| 2022-06-13 | Add Operation | see changesets |