Firewall Template API Reference - Simple Application Server - Alibaba Cloud - Simple Application Server

Queries firewall template details.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
FirewallTemplateId	array	No	The IDs of the firewall templates.
	string	No	The ID of the firewall template.	ft-bcf1a7hrdq717****
Name	string	No	The name of the firewall template.	testName
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
TotalCount	integer	The total number of entries returned.	10
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 20.	20
FirewallTemplates	array<object>	The queried firewall templates.
	array<object>
FirewallTemplateId	string	The ID of the firewall template.	ft-bcf1a7hrdq717****
CreationTime	string	The time when the firewall template was created, in the yyyy-MM-ddTHH:mm:ssZ format as defined by ISO 8601. The time is in UTC.	2024-04-10T02:10:14Z
Name	string	The name of the firewall template.	test
Description	string	The description of the firewall template.	test
CreateTime	string	The time when the firewall template was created, in the yyyy-MM-ddTHH:mm:ssZ format as defined by ISO 8601. The time is in UTC. Note The time displayed in the Simple Application Server console is in the format of UTC+8.	2024-04-29T02:01:38Z
FirewallTemplateRules	array<object>	The firewall template rules.
	object
FirewallTemplateRuleId	string	The ID of the firewall template rule.	eeea34d9867b4d55a4ff8d5fcfbd****
RuleProtocol	string	The transport layer protocol that the rule supports. Valid values: TCP UDP TCP+UDP ICMP	TCP
Port	string	The port range. Valid values: 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: `1024/1055`, which indicates the port range from 1024 to 1055. Note If you set RuleProtocol to ICMP, you must set Port to -1/-1.	8080
SourceCidrIp	string	The source address to which access is granted. CIDR blocks and IPv4 addresses are supported.	119.145.XX.XX
Remark	string	The remarks of the firewall template rule.	test

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 20,
  "FirewallTemplates": [
    {
      "FirewallTemplateId": "ft-bcf1a7hrdq717****",
      "CreationTime": "2024-04-10T02:10:14Z",
      "Name": "test",
      "Description": "test",
      "CreateTime": "2024-04-29T02:01:38Z",
      "FirewallTemplateRules": [
        {
          "FirewallTemplateRuleId": "eeea34d9867b4d55a4ff8d5fcfbd****",
          "RuleProtocol": "TCP",
          "Port": "8080",
          "SourceCidrIp": "119.145.XX.XX",
          "Remark": "test"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.