All Products
Search
Document Center

Bastionhost:ConfigInstanceWhiteList

Last Updated:Nov 27, 2024

Configures a whitelist of public IP addresses for a bastion host.

Operation description

Usage notes

You can call this operation to configure a whitelist of public IP addresses for a bastion host. By default, a bastion host is accessible from all public IP addresses. If you want to allow the requests from specific public IP addresses, you can call this operation to add trusted IP addresses to the whitelist of the bastion host.

Limits

You can call this operation up to 30 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

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

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host for which you want to configure a whitelist of public IP addresses.

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

The region ID of the bastion host.

cn-hangzhou
WhiteListarrayNo

The IP address whitelist that you want to configure.

stringNo

The IP addresses that you want to include in the whitelist. You can specify up to 50 IP addresses. To add multiple IP addresses to the whitelist, separate the IP addresses with commas (,).

10.162.XX.XX,192.168.XX.XX

Response parameters

ParameterTypeDescriptionExample
object
InstanceIdstring

The ID of the bastion host for which a whitelist of public IP addresses is configured.

bastionhost-cn-78v1gh****
RequestIdstring

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

47820E32-5968-45CF-982F-09CB80DC180B

Examples

Sample success responses

JSONformat

{
  "InstanceId": "bastionhost-cn-78v1gh****",
  "RequestId": "47820E32-5968-45CF-982F-09CB80DC180B"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-21The internal configuration of the API is changed, but the call is not affectedView Change Details