CreateFirewallRule - Simple Application Server - Alibaba Cloud Documentation Center

Creates a firewall rule for a simple application server.

Operation description

Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.

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.

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
swas-open:CreateFirewallRule	create	Instance acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the simple application server.	ace0706b2ac4454d984295a94213****
RegionId	string	Yes	The region ID of the simple application server.	cn-hangzhou
RuleProtocol	string	Yes	The transport layer protocol. Valid values: TCP UDP TCP+UDP ICMP	TCP
Port	string	Yes	The port range. When the transport layer protocol is TCP and/or UDP, the port range is 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: 1024/1055, which specifies the port range from 1024 to 1055. When the transport layer protocol is ICMP, the port range is -1/-1, which indicates all ports.	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 token, but you must make sure that the token 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 remarks of the firewall rule.	TEST

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.
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.
500	InternalError	An error occurred while processing your request.

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

Change history

Change time	Summary of changes	Operation
2023-09-18	API Description Update. The Error code has changed	View Change Details