DescribeFirewallRules - - Alibaba Cloud Documentation Center

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

polardb:DescribeFirewallRules

get

*DBCluster

acs:polardb:*:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*****************
RuleNameList	string	No	The names of the firewall rules to query. To query multiple rules, separate the rule names with commas (,). Note Call the DescribeFirewallRules operation to view the details of all firewall rules for the target cluster, including the rule names.	testrule

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264
Message	string	The response message. Note If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.	Message
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The result set.
RuleList	array	The list of firewall rules.
	string	The rule object.	"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-********","EndpointType":"Custom","DBEndpointDescription":"pc-*******"},{"EndpointName":"pe-**********","EndpointType":"Custom","DBEndpointDescription":"pc-*********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"
DBClusterId	string	The cluster ID.	pc-*****************

Examples

Success response

JSON format

{
  "RequestId": "84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264",
  "Message": "Message",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\"mode\":\"Defending\",\"endpoint\":\"[{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Cluster\",\"DBEndpointDescription\":\"Cluster Address\"},{\"EndpointName\":\"pe-************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"},{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"}]\",\"id\":\"test\",\"sub_rules\":[],\"type\":\"BlackList\",\"enabled\":\"true\",\"users\":{\"applies_to\":[]}}\""
    ]
  },
  "DBClusterId": "pc-*****************\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.