Modifies the settings of Active Directory (AD) authentication on a bastion host.
Debugging
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 Resourcesis 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:ModifyInstanceADAuthServer | Write |
|
| 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. For more information about the mapping between region IDs and region names, see Regions and zones. | cn-hangzhou |
| Server | string | Yes | The address of the AD server. | 192.168.XX.XX |
| StandbyServer | string | No | The address of the secondary AD server. | 192.168.XX.XX |
| Port | integer | Yes | The port that is used to access the AD server. | 389 |
| IsSSL | boolean | Yes | Specifies whether to support SSL. Valid values:
| true |
| BaseDN | string | Yes | The Base distinguished name (DN). | dc=test,dc=com |
| Domain | string | Yes | The domain on the AD server. | domain |
| Account | string | Yes | The username of the account that is used for the AD server. | cn=Manager,dc=test,dc=com |
| Password | string | No | The password of the account that is used for the AD server. | ****** |
| Filter | string | No | The condition that is used to filter users. | (objectClass=top) |
| NameMapping | string | No | The field that is used to indicate the name of a user on the AD server. | nameAttr |
| EmailMapping | string | No | The field that is used to indicate the email address of a user on the AD server. | emailAttr |
| MobileMapping | string | No | The field that is used to indicate the mobile phone number of a user on the AD server. | mobileAttr |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "C9E97677-BD74-584B-AFCE-948C2A70BB82"
}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.