You can call the DescribeADInfo operation to query 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeADInfo

The operation that you want to perform. Set the value to DescribeADInfo.

ClientToken String No ETnLKlblzczshOTUbOCz*****

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-bp1k8s41l2o52****

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

RegionId String Yes cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
ADStatus String 1

The status of the AD domain. Valid values:

  • -1: The instance is being added to the AD domain.
  • 0: The instance fails to be added to the AD domain.
  • 1: The instance is added to the AD domain.
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

ADDNS String 100.100.XX.XX

The DNS information about the AD domain.

ADServerIpAddress String 192.168.XX.XX

The service IP address of the AD domain.

AbnormalReason String XXXX

The cause of the exception.

UserName String test_01

The username of the AD domain.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeADInfo
&ClientToken=ETnLKlblzczshOTUbOCz*****
&DBInstanceId=rm-bp1k8s41l2o52****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeADInfoResponse>
    <RequestId>DA62101F-9710-506F-B9A4-DD89C432B04B</RequestId>
</DescribeADInfoResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "DA62101F-9710-506F-B9A4-DD89C432B04B"
}

Error codes

For a list of error codes, visit the API Error Center.