All Products
Search
Document Center

ApsaraDB RDS:ModifyADInfo

Last Updated:Jul 05, 2024

Modifies the AD domain information about an ApsaraDB RDS for SQL Server instance.

Operation description

Supported database engine

  • SQL Server

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

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
ClientTokenstringNo

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
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
RegionIdstringYes

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

cn-hangzhou
ADDNSstringNo

The DNS information about the AD domain.

example.com
ADServerIpAddressstringNo

The IP address of the AD domain.

47.100.XX.XX
ADAccountNamestringNo

The account of the AD domain.

test_account
ADPasswordstringNo

The password for the account of the AD domain.

test_password

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

Error codes

HTTP status codeError codeError messageDescription
400EngineVersionNotSupportedThe current engineVersion does not support AD operation.-
400InvalidADDNS.NotFoundSpecified adDNS is null.Specified ADDNS is null.
400InvalidAdServerIpAddress.NotFoundSpecified adServer IpAddress is null.-
400InvalidAdAccountName.NotFoundSpecified adAccountName is null.-
400InvalidAdPassword.NotFoundSpecified adPassword is null.-
400InvalidShareDbInstanceClassNotSupportThe current instance classType does not support this operation.-
400InvalidNodeType.NotSupportThe 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 timeSummary of changesOperation
2023-11-21The Error code has changedView Change Details
2022-06-13Add OperationView Change Details