All Products
Search

This Product

    Bastionhost:ModifyInstanceLDAPAuthServer

    Document Center

    Bastionhost:ModifyInstanceLDAPAuthServer

    Last Updated:Apr 22, 2026

    Updates the settings of the Lightweight Directory Access Protocol (LDAP) authentication server of 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 bastion host ID.

    Note

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

    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
    Server

    string

    Yes

    The address of the LDAP server.

    192.168.XX.XX
    StandbyServer

    string

    No

    The address of the secondary LDAP server.

    192.168.XX.XX
    Port

    string

    Yes

    The port that is used to access the LDAP server.

    389
    IsSSL

    string

    No

    Specifies whether to support SSL. Valid values:

    • true

    • false

    true
    BaseDN

    string

    Yes

    The Base distinguished name (DN).

    dc=test,dc=com
    Account

    string

    Yes

    The username of the account that is used for the LDAP server.

    cn=Manager,dc=test,dc=com
    Password

    string

    No

    The password of the account that is used for the LDAP server. You must configure a password when you configure LDAP authentication. If you leave this parameter empty when you modify the settings of LDAP authentication, the current password is used.

    ******
    Filter

    string

    No

    The condition that is used to filter users.

    (objectClass=top)
    LoginNameMapping

    string

    No

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

    userNameAttr
    NameMapping

    string

    No

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

    nameAttr
    EmailMapping

    string

    No

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

    emailAttr
    MobileMapping

    string

    No

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

    mobileAttr

    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.

    8F1085E3-F048-5F34-B650-F145216E4AA4

    Examples

    Success response

    JSON format

    {
  "RequestId": "8F1085E3-F048-5F34-B650-F145216E4AA4"
}

    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.