GetInstanceADAuthServer - 查询堡垒机实例上AD认证的配置信息_运维安全中心（堡垒机）-阿里云帮助中心

接口说明

使用说明

本接口用于查询堡垒机实例上AD认证的配置信息。通过堡垒机的AD认证功能，可以将AD服务器的用户同步到堡垒机。同步成功后，用户可通过堡垒机运维服务器。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:GetInstanceADAuthServer	Read	全部资源	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	要查询的堡垒机实例的ID。您可以调用DescribeInstances接口获取该参数。	bastionhost-cn-st220aw****
RegionId	string	否	要查询的堡垒机实例的地域ID。说明地域ID和地域名称的对应关系，请参见地域和可用区。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50
AD	object	AD认证的配置信息。
Account	string	服务器账号的DN。	cn=Manager,dc=test,dc=com
BaseDN	string	连接AD服务器的BASE DN。	dc=test,dc=com
Domain	string	AD服务器上的域。	domain
EmailMapping	string	AD服务器上对应的用户邮箱的字段名称。	emailAttr
Filter	string	用户的筛选条件。	(&(objectClass=top))
IsSSL	boolean	是否支持SSL。取值： true：是 false：否	true
MobileMapping	string	AD服务器上对应的用户手机号的字段名称。	mobileAttr
NameMapping	string	AD服务器上对应的用户名称的字段名称。	nameAttr
HasPassword	boolean	是否设置密码。取值： true：设置密码 false：未设置密码	true
Port	long	服务器的端口。	389
Server	string	服务器的地址。	192.168.XX.XX
StandbyServer	string	备用服务器的地址。	192.168.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50",
  "AD": {
    "Account": "cn=Manager,dc=test,dc=com",
    "BaseDN": "dc=test,dc=com",
    "Domain": "domain",
    "EmailMapping": "emailAttr",
    "Filter": "(&(objectClass=top))",
    "IsSSL": true,
    "MobileMapping": "mobileAttr",
    "NameMapping": "nameAttr",
    "HasPassword": true,
    "Port": 389,
    "Server": "192.168.XX.XX",
    "StandbyServer": "192.168.XX.XX"
  }
}

错误码

Http code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误

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