GetInstanceADAuthServer - Bastionhost - Alibaba Cloud Documentation Center

Queries the settings of Active Directory (AD) authentication on a bastion host.

Operation description

You can call this operation to query the settings of AD authentication on a bastion host. After you configure AD authentication on a bastion host, you can import AD-authenticated users into the bastion host. After the AD-authenticated users are imported into the bastion host, the AD-authenticated users can log on to the bastion host to perform O&M operations on servers.

Limit

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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:GetInstanceADAuthServer	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host. 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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50
AD	object	The settings of AD authentication.
Account	string	The distinguished name (DN) of the AD server account.	cn=Manager,dc=test,dc=com
BaseDN	string	The Base DN of the AD server.	dc=test,dc=com
Domain	string	The domain on the AD server.	domain
EmailMapping	string	The field that is used to indicate the email address of a user on the AD server.	emailAttr
Filter	string	The condition that is used to filter users.	(&(objectClass=top))
IsSSL	boolean	Indicates whether SSL is supported. Valid values: true false	true
MobileMapping	string	The field that is used to indicate the mobile phone number of a user on the AD server.	mobileAttr
NameMapping	string	The field that is used to indicate the name of a user on the AD server.	nameAttr
HasPassword	boolean	Indicates whether passwords are required. Valid values: true: false	true
Port	long	The port that is used to access the AD 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

Sample success responses

JSONformat

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50",
  "AD": {
    "Account": "cn=Manager,dc=test,dc=com",
    "BaseDN": "dc=test,dc=com",
    "Domain": "domain",
    "EmailMapping": "emailAttr",
    "Filter": "(&(objectClass=top))",
    "IsSSL": true,
    "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.