DescribeADInfo - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeADInfo operation to query the information about the Active Directory (AD) domain of an ApsaraDB RDS for SQL Server instance.

Operation Description

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.

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 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
rds:DescribeADInfo	Read	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	ETnLKlblzczshOTUbOCz*****
DBInstanceId	string	Yes	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.	rm-bp1k8s41l2o52****
RegionId	string	Yes	The ID of the region.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
ADStatus	string	The username of the AD domain.	1
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ADDNS	string	The operation that you want to perform. Set the value to DescribeADInfo.	100.100.XX.XX

Examples

Sample success responses

JSONformat

{
  "ADStatus": "1",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ADDNS": "100.100.XX.XX",
  "ADServerIpAddress": "192.168.XX.XX",
  "AbnormalReason": "XXXX",
  "UserName": "test_01"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-06-13	Add Operation