Query firewall rules by using ListFirewallRules - Simple Application Server - Alibaba Cloud - Simple Application Server

Queries the firewall rules of a specified simple application server.

Operation description

You can call this API operation to query the firewall rules of a specified simple application server, including information such as the port range, firewall rule ID, and transport layer protocol.

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

get

FirewallRule

acs:swas-open:{#regionId}:{#accountId}:firewallrule/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID of the specified simple application server.	ace0706b2ac4454d984295a94213****
RegionId	string	Yes	The region ID of the simple application server.	cn-hangzhou
PageSize	integer	No	The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number of the firewall rule list. Starting value: 1. Default value: 1.	1
Tag	array<object>	No	The tags of the firewall rules.
	object	No	The tag.
Key	string	No	The tag key of the firewall rule. The tag key must be 1 to 64 characters in length. Valid values of N: 1 to 20.	TestKey
Value	string	No	The tag value of the firewall rule. The tag value must be 1 to 64 characters in length. Valid values of N: 1 to 20.	TestValue
FirewallRuleId	string	No	The ID of the firewall rule.	1a16263ab0f541288312a15fa64280de

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of firewall rules.	4
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	The paging Settings for the number of entries per page in a paged query.	10
PageNumber	integer	The page number of the firewall rule list.	1
FirewallRules	array<object>	The list of firewall rules.
	array<object>
Remark	string	The remark of the firewall rule.	test-default port for MySQL server
Port	string	The port range.	3306
RuleId	string	The ID of the firewall rule.	eeea34d9867b4d55a4ff8d5fcfbd****
RuleProtocol	string	The transport layer protocol. Valid values: TCP: TCP. UDP: UDP. TCP+UDP: TCP and UDP.	TCP
Policy	string	The firewall policy. Valid values: accept: Allow. drop: Deny.	accept
Tags	array<object>	The tags of the firewall rules.
	object	The tag.
Key	string	The tag key of the firewall rule.	TestKey
Value	string	The tag value of the firewall rule.	TestValue
SourceCidrIp	string	The source CIDR block.	0.0.0.0/0
InstanceId	string	The ID of the simple application server to which the firewall rule belongs.	ace0706b2ac4454d984295a94213****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.