Use CreateFirewallRule to create a firewall rule - Simple Application Server - Alibaba Cloud - Simple Application Server

Operation description

Firewalls control network access to simple application servers and are used to divide security domains in the cloud. By default, the firewall of each simple application server allows traffic on port 22 (SSH), port 80 (HTTP), and port 443 (HTTPS). All other ports are disabled by default. You can add firewall rules to allow traffic on more ports.

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

swas-open:CreateFirewallRule

create

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the specified simple application server.	ace0706b2ac4454d984295a94213****
RegionId	string	Yes	The region ID of the specified simple application server.	cn-hangzhou
RuleProtocol	string	Yes	The transport layer protocol. Valid values: TCP: TCP UDP: UDP TCP+UDP: TCP and UDP ICMP: ICMP	TCP
Port	string	Yes	The port range. TCP/UDP: Valid values: 1 to 65535. Use a forward slash (/) to separate the start port and the end port. For example, 1024/1055 indicates the port range from 1024 to 1055. ICMP: -1/-1. This value indicates all ports.	3306/3306
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
Remark	string	No	The remark for the firewall rule.	TEST

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
FirewallId	string	The ID of the firewall rule.	8007e18c61024aafbd776d52d0****

Examples

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "FirewallId": "8007e18c61024aafbd776d52d0****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidProtocol.ValueNotSupported	The specified parameter Protocol is invalid.
400	InvalidPort.ValueNotSupported	The specified parameter Port is invalid.
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
500	InternalError	An error occurred while processing your request.
403	FirewallRuleLimitExceed	The maximum number of firewall rules in an instance is exceeded.
403	FirewallRuleAlreadyExist	The specified Rule already exist
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.