All Products
Search

This Product

    Bastionhost:GetInstanceLDAPAuthServer

    Document Center

    Bastionhost:GetInstanceLDAPAuthServer

    Last Updated:Apr 22, 2026

    Queries the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the bastion host.

    Note

    You can call the DescribeInstances operation to query the ID of the bastion host.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the bastion host.

    Note

    For more information about the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the request, which is used to locate and troubleshoot issues.

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

    object

    The settings of LDAP authentication.

    Account

    string

    The account of the LDAP server.

    cn=Manager,dc=test,dc=com
    BaseDN

    string

    The Base distinguished name (DN).

    dc=test,dc=com
    EmailMapping

    string

    The field that is used to indicate the email address of a user on the LDAP server.

    emailAttr
    Filter

    string

    The condition that is used to filter users.

    (&(objectClass=top))
    IsSSL

    boolean

    Indicates whether SSL is supported. Valid values:

    • true: supported

    • false: not supported

    true
    LoginNameMapping

    string

    The field that is used to indicate the logon name of a user on the LDAP server.

    userNameAttr
    MobileMapping

    string

    The field that is used to indicate the mobile phone number of a user on the LDAP server.

    mobileAttr
    NameMapping

    string

    The field that is used to indicate the name of a user on the LDAP server.

    nameAttr
    HasPassword

    string

    Indicates whether passwords are required. Valid values:

    • true: required

    • false: not required

    true
    Port

    integer

    The port that is used to access the LDAP server.

    389
    Server

    string

    The address of the LDAP server.

    192.168.XX.XX
    StandbyServer

    string

    The address of the secondary LDAP server.

    192.168.XX.XX

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The argument is invalid. The argument is invalid.
    500 InternalError An unknown error occurred. An unknown error occurred.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.