tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud LighthouseFirewall APIsDescribeFirewallRules
DescribeFirewallRules
Last updated: 2023-12-04 16:32:01
DescribeFirewallRules
Last updated: 2023-12-04 16:32:01

1. API Description

Domain name for API request: lighthouse.tencentcloudapi.com.

This API is used to query the firewall rules of an instance.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeFirewallRules.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible firewall rules.
FirewallRuleSet Array of FirewallRuleInfo Firewall rule details list.
FirewallVersion Integer Firewall version number.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying all the firewall rules of instance

Input Example

https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&<Common request parameters>

Output Example

{
    "Response": {
        "FirewallRuleSet": [
            {
                "Action": "DROP",
                "AppType": "Custom",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "",
                "Port": "22,88",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "Custom",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "test",
                "Port": "88",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "HTTP(80)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "test",
                "Port": "80",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "HTTPS(443)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow web service HTTPS (443), such as Apache and Nginx",
                "Port": "443",
                "Protocol": "TCP"
            }
        ],
        "FirewallVersion": 1,
        "RequestId": "afa0c876-336a-4ed6-ad01-89b3b2632207",
        "TotalCount": 4
    }
}

Example2 Querying certain firewall rules of instance

Input Example

https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&Offset=0
&Limit=1
&<Common request parameters>

Output Example

{
    "Response": {
        "FirewallRuleSet": [
            {
                "Action": "DROP",
                "AppType": "Custom",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "",
                "Port": "22,88",
                "Protocol": "TCP"
            }
        ],
        "FirewallVersion": 1,
        "RequestId": "31522fb9-fef8-4190-9080-deba504c36ae",
        "TotalCount": 4
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.Negative Invalid parametric value: it cannot be negative.
InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
ResourceNotFound.FirewallNotFound The firewall does not exist.
ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
UnauthorizedOperation.NoPermission No permission
UnauthorizedOperation.TokenInvalid
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon