调用GetInstanceADAuthServer接口查询堡垒机实例上AD认证的配置信息。

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetInstanceADAuthServer

要执行的操作。取值:GetInstanceADAuthServer

InstanceId String bastionhost-cn-st220aw****

要查询的堡垒机实例的ID。

您可以调用DescribeInstances接口获取该参数。

RegionId String cn-hangzhou

要查询的堡垒机实例的地域ID。

说明 地域ID和地域名称的对应关系,请参见地域和可用区

返回数据

名称 类型 示例值 描述
RequestId String 89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

AD Object

AD认证的配置信息。

Account String cn=Manager,dc=test,dc=com

服务器账号的DN。

BaseDN String dc=test,dc=com

连接AD服务器的BASE DN。

Domain String domain

AD服务器上的域。

EmailMapping String emailAttr

AD服务器上对应的用户邮箱的字段名称。

Filter String (&(objectClass=top))

用户的筛选条件。

IsSSL Boolean true

是否支持SSL。取值:

  • true:是
  • false:否
MobileMapping String mobileAttr

AD服务器上对应的用户手机号的字段名称。

NameMapping String nameAttr

AD服务器上对应的用户名称的字段名称。

HasPassword Boolean true

是否设置密码。取值:

  • true:设置密码
  • false:未设置密码
Port Long 389

服务器的端口。

Server String 192.168.XX.XX

服务器的地址。

StandbyServer String 192.168.XX.XX

备用服务器的地址。

示例

请求示例

http(s)://[Endpoint]/?Action=GetInstanceADAuthServer
&InstanceId=bastionhost-cn-st220aw****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  }
}

错误码

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

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