GetInstanceLDAPAuthServer - Bastionhost - Alibaba Cloud Documentation Center

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:GetInstanceLDAPAuthServer

get

*All Resource

*

None

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.