GetInstanceLDAPAuthServer - Bastionhost - Alibaba Cloud Documentation Center

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetInstanceLDAPAuthServer	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Indicates whether passwords are required. Valid values: true: required false: not required	bastionhost-cn-st220aw****
RegionId	string	No	The operation that you want to perform. Set the value to GetInstanceLDAPAuthServer.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The settings of LDAP authentication.	1C60E741-102D-5E8F-9710-B06D3F0183FE
LDAP	object	Indicates whether SSL is supported. Valid values: true: supported false: not supported
Account	string	The ID of the bastion host. Note You can call the DescribeInstances operation to query the ID of the bastion host.	cn=Manager,dc=test,dc=com
BaseDN	string	The field that is used to indicate the logon name of a user on the LDAP server.	dc=test,dc=com
EmailMapping	string	The address of the secondary LDAP server.	emailAttr
Filter	string	The Base distinguished name (DN).	(&(objectClass=top))
IsSSL	boolean	The condition that is used to filter users.	true
LoginNameMapping	string	The port that is used to access the LDAP server.	userNameAttr
MobileMapping	string	The field that is used to indicate the email address of a user on the LDAP server.	mobileAttr
NameMapping	string	The field that is used to indicate the mobile phone number of a user on the LDAP server.	nameAttr
HasPassword	string	The ID of the request, which is used to locate and troubleshoot issues.	true

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

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