调用GetInstanceLDAPAuthServer接口获取堡垒机实例LDAP认证的配置。

调试

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

请求参数

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

要执行的操作。取值:GetInstanceLDAPAuthServer

InstanceId String bastionhost-cn-st220aw****

堡垒机的实例ID。

说明 您可以调用DescribeInstances接口获取该参数。
RegionId String cn-hangzhou

堡垒机的地域ID。

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

返回数据

名称 类型 示例值 描述
RequestId String 1C60E741-102D-5E8F-9710-B06D3F0183FE

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

LDAP Object

LDAP认证的配置信息。

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

服务器的账号。

BaseDN String dc=test,dc=com

基准域名(Base DN)。

EmailMapping String emailAttr

用户邮箱对应的服务器的属性名。

Filter String (&(objectClass=top))

用户的筛选条件。

IsSSL Boolean true

是否支持SSL。取值:

  • true:支持
  • false:不支持
LoginNameMapping String userNameAttr

用户登录名对应服务器属性名。

MobileMapping String mobileAttr

用户手机号对应的服务器的属性名。

NameMapping String nameAttr

用户名称对应的服务器的属性名。

HasPassword String true

是否设置密码。取值:

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

访问服务器的端口。

Server String 192.168.XX.XX

服务器的地址。

StandbyServer String 192.168.XX.XX

备用服务器的地址。

示例

请求示例

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

正常返回示例

XML格式

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

<GetInstanceLDAPAuthServerResponse>
    <RequestId>1C60E741-102D-5E8F-9710-B06D3F0183FE</RequestId>
    <LDAP>
        <Account>cn=Manager,dc=test,dc=com</Account>
        <BaseDN>dc=test,dc=com</BaseDN>
        <EmailMapping>emailAttr</EmailMapping>
        <Filter>(&amp;(objectClass=top))</Filter>
        <IsSSL>true</IsSSL>
        <LoginNameMapping>userNameAttr</LoginNameMapping>
        <MobileMapping>mobileAttr</MobileMapping>
        <NameMapping>nameAttr</NameMapping>
        <HasPassword>true</HasPassword>
        <Port>389</Port>
        <Server>192.168.XX.XX</Server>
        <StandbyServer>192.168.XX.XX</StandbyServer>
    </LDAP>
</GetInstanceLDAPAuthServerResponse>

JSON格式

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

{
  "RequestId" : "1C60E741-102D-5E8F-9710-B06D3F0183FE",
  "LDAP" : {
    "Account" : "cn=Manager,dc=test,dc=com",
    "BaseDN" : "dc=test,dc=com",
    "EmailMapping" : "emailAttr",
    "Filter" : "(&(objectClass=top))",
    "IsSSL" : true,
    "LoginNameMapping" : "userNameAttr",
    "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. 未知错误

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