All Products
Document Center


Last Updated:Jan 12, 2023

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

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
yundun-bastionhost:GetInstanceLDAPAuthServer Read
    All resources

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.
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.

Response parameters

Parameter Type Description Example

Schema of Response

RequestId string

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

LDAP object

The settings of LDAP authentication.

Account string

The account of the LDAP server.

BaseDN string

The Base distinguished name (DN).

EmailMapping string

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

Filter string

The condition that is used to filter users.

IsSSL boolean

Indicates whether SSL is supported. Valid values:

  • true: supported
  • false: not supported
LoginNameMapping string

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

MobileMapping string

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

NameMapping string

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

HasPassword string

Indicates whether passwords are required. Valid values:

  • true: required
  • false: not required
Port long

The port that is used to access the LDAP server.

Server string

The address of the LDAP server.

StandbyServer string

The address of the secondary LDAP server.



Normal return example


  "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 code Error code Error message
400 InvalidParameter The argument is invalid.
500 InternalError An unknown error occurred.

For a list of error codes, visit the API error center.