调用DescribeADInfo查询AD域关联_云数据库 RDS-阿里云帮助中心

调用DescribeADInfo查询当前实例域相关信息, 包括是否已经加入域、域名称、所使用账号等。

接口说明

该接口仅支持RDS SQL Server实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeADInfo	Read	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。	ETnLKlblzczshOTUbOCz*****
DBInstanceId	string	是	实例ID。可调用DescribeDBInstances获取。	rm-bp1k8s41l2o52****
RegionId	string	是	地域ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
ADStatus	string	AD域的状态。返回值： -1：正在加入AD域。 0：加入AD域失败。 1：加入AD域成功。	1
RequestId	string	请求ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ADDNS	string	AD域的DNS信息。	100.100.XX.XX
ADServerIpAddress	string	AD域的服务IP地址。	192.168.XX.XX
AbnormalReason	string	异常原因。	XXXX
UserName	string	AD域的用户名。	test_01

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-06-13	新增 OpenAPI	看变更集