Batch Deploy Firewall Templates with CreateFirewallTemplate API - Simple Application Server - Alibaba Cloud - Simple Application Server

Creates a firewall template.

Operation description

A firewall template allows you to group multiple firewall rules. You can use a template to add a set of firewall rules to one or more instances simultaneously, improving the efficiency of configuring firewall rules.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Simple Application Server instance. You can call the ListRegions operation to query the list of supported Alibaba Cloud regions.	cn-hangzhou
Name	string	Yes	The name of the firewall template.	testName
Description	string	No	The description of the firewall template.	test
FirewallRule	array<object>	No	The firewall rules.
	object	No	The firewall rules.
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. Valid values: 1 to 65535. Use a forward slash (/) to separate the start port and the end port. For example, `1024/1055` indicates a port range from 1024 to 1055. Note If you set the protocol to ICMP, the port must be set to -1/-1.	8080
SourceCidrIp	string	Yes	The source IPv4 CIDR block for which to set access permissions. Both CIDR and IPv4 formats are supported for the IP address range.	223.166.XX.XX
Remark	string	No	The remark for the firewall rule.	Custom rule

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
FirewallTemplateId	string	The firewall template ID.	ft-bcf1a7hrdq717****

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "FirewallTemplateId": "ft-bcf1a7hrdq717****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.