All Products
Search
Document Center

Bastionhost:GetInstanceLDAPAuthServer

Last Updated:Nov 27, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:GetInstanceLDAPAuthServerget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-st220aw****
RegionIdstringNo

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 parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

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

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

The settings of LDAP authentication.

Accountstring

The account of the LDAP server.

cn=Manager,dc=test,dc=com
BaseDNstring

The Base distinguished name (DN).

dc=test,dc=com
EmailMappingstring

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

emailAttr
Filterstring

The condition that is used to filter users.

(&(objectClass=top))
IsSSLboolean

Indicates whether SSL is supported. Valid values:

  • true: supported
  • false: not supported
true
LoginNameMappingstring

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

userNameAttr
MobileMappingstring

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

mobileAttr
NameMappingstring

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

nameAttr
HasPasswordstring

Indicates whether passwords are required. Valid values:

  • true: required
  • false: not required
true
Portlong

The port that is used to access the LDAP server.

389
Serverstring

The address of the LDAP server.

192.168.XX.XX
StandbyServerstring

The address of the secondary LDAP server.

192.168.XX.XX

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.