Restrict Public Access via Bastionhost IP Whitelist - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

Configures the public IP address whitelist for a Bastionhost instance. By default, all public IP addresses are allowed to access the Bastionhost instance. To restrict public network access, call this operation to add specified public IP addresses to the whitelist and restrict public network traffic to the Bastionhost instance.

The queries per second (QPS) limit for a single user is 30 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.

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:ConfigInstanceWhiteList

update

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the Bastionhost instance for which you want to configure the public IP address whitelist. Note You can call the DescribeInstances operation to query instance ID of the Bastionhost instance.	bastionhost-cn-78v1gh****
RegionId	string	No	The region ID of the Bastionhost instance.	cn-hangzhou
WhiteList	array	No	The IP address whitelist to be configured.	10.162.XX.XX
	string	No	The IP address whitelist to be configured. You can configure up to 50 IP addresses. To add multiple IP addresses to the whitelist, separate them with commas (,). The whitelist cannot contain 0.0.0.0/0.	10.162.XX.XX,192.168.XX.XX
WhiteListPolicies	array<object>	No	The IP address whitelist to be configured.
	object	No
Entry	string	No	The IP address whitelist to be configured. You can configure up to 50 IP addresses. To add multiple IP addresses to the whitelist, separate them with commas (,). The whitelist cannot contain 0.0.0.0/0.	10.162.XX.XX,192.168.XX.XX
Description	string	No	The remark or description for the whitelist rule.	description

Response elements

Element	Type	Description	Example
	object	The response data.
InstanceId	string	The instance ID of the Bastionhost instance for which the public IP address whitelist is configured.	bastionhost-cn-78v1gh****
RequestId	string	The ID of the request. The ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	47820E32-5968-45CF-982F-09CB80DC180B

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.