ListFirewallRules - Simple Application Server - Alibaba Cloud Documentation Center

Queries the firewall rules of a simple application server.

Operation description

You can call the ListFirewallRules operation to query the firewall rule details of a simple application server, including the port range, firewall rule ID, and transport layer protocol.

QPS limit

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
Tag	object []	No	The tags of the firewall rule.
Key	string	No	The key of tag N to be added to the firewall rule. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N to be added to the firewall rule. Valid values of N: 1 to 20.	TestValue
FirewallRuleId	string	No	The ID of the firewall rule.	1a16263ab0f541288312a15fa64280de

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	4
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
FirewallRules	object []	The array of firewall rules.
Remark	string	The remarks of the firewall rule.	TEST
Port	string	The port range.	3306
RuleId	string	The ID of the firewall rule.	eeea34d9867b4d55a4ff8d5fcfbd****
RuleProtocol	string	The transport layer protocol. Valid values: TCP UDP TCP+UDP	TCP
Policy	string	The firewall policy. Valid values: accept: Access is allowed. drop: Access is refused.	accept
Tags	object []	The tags of the firewall rule.
Key	string	The key of tag N to be added to the firewall rule. Valid values of N: 1 to 20.	TestKey
Value	string	The value of tag N to be added to the firewall rule. Valid values of N: 1 to 20.	TestValue
SourceCidrIp	string	The source CIDR block.	0.0.0.0/0

Examples

Sample success responses

JSONformat

{
  "TotalCount": 4,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "FirewallRules": [
    {
      "Remark": "TEST",
      "Port": "3306",
      "RuleId": "eeea34d9867b4d55a4ff8d5fcfbd****",
      "RuleProtocol": "TCP",
      "Policy": "accept",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "SourceCidrIp": "0.0.0.0/0"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
403	InvalidParam	The specified parameter value is invalid.
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

2024-02-20

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag
	Added Input Parameters: FirewallRuleId
Output Parameters	The response structure of the API has changed.

2023-05-25

API Description Update. The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.