DescribeFirewallTemplates - Simple Application Server - Alibaba Cloud Documentation Center

Queries details about firewall templates.

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:DescribeFirewallTemplates	list	All Resources *	none	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 parameters

Parameter	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 information about the queried firewall templates.
firewallTemplate	object
FirewallTemplateId	string	The ID of the firewall template.	ft-bcf1a7hrdq717****
CreationTime	string	The time when the firewall template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed 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. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed 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 details of the firewall template rules.
firewallTemplateRule	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 that the port range of 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 you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.	119.145.XX.XX
Remark	string	The remarks of the firewall template rule.	test

Examples

Sample success responses

JSONformat

{
  "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

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