GetInstanceLDAPAuthServer - 获取堡垒机实例LDAP认证的配置

更新时间:
复制为 MD 格式

获取堡垒机实例LDAP认证的配置。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

堡垒机的实例 ID。

说明

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

bastionhost-cn-st220aw****

RegionId

string

堡垒机的地域 ID。

说明

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

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

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

1C60E741-102D-5E8F-9710-B06D3F0183FE

LDAP

object

LDAP 认证的配置信息。

Account

string

服务器的账号。

cn=Manager,dc=test,dc=com

BaseDN

string

基准域名(Base DN)。

dc=test,dc=com

EmailMapping

string

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

emailAttr

Filter

string

用户的筛选条件。

(&(objectClass=top))

IsSSL

boolean

是否支持 SSL。取值:

  • true:支持

  • false:不支持

true

LoginNameMapping

string

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

userNameAttr

MobileMapping

string

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

mobileAttr

NameMapping

string

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

nameAttr

HasPassword

string

是否设置密码。取值:

  • true:设置密码

  • false:未设置密码

true

Port

integer

访问服务器的端口。

389

Server

string

服务器的地址。

192.168.XX.XX

StandbyServer

string

备用服务器的地址。

192.168.XX.XX

示例

正常返回示例

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"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The argument is invalid. 参数错误
500 InternalError An unknown error occurred. 未知错误

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

变更历史

更多信息,参考变更详情