tencent cloud

Tencent Cloud Lighthouse

Release Notes and Announcements
Image Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Strengths
Scenarios
Use Limits
Region and Network Connectivity
Product Comparison
User Guide
Billing
Billing Overview
Instance Package
Pricing Details
Purchase Methods
Configuration Adjustment (for Upgrade Only)
Overdue Payments
Refund
Getting Started
One-Click Application Creation Using Lighthouse
Quick Instance Creation
User Guide
Instances
Cloud Disks
Images
Firewall
Private Network Interconnection
Data Backup and Restoration Using Snapshots
Cloud Access Management
OPS and Monitoring
File Transfer
Use Cases
Website Building
Development Environment Building
Cloud Storage System Building
E-commerce Platform Building
Personal Live Streaming Room Building
FTP Service Building
SSL Certificate Installation
Troubleshooting
Windows Instance: RDP Connection to the Remote Computer Fails
Windows Instance: Offline Password Resetting Fails or Invalid
Linux/Windows Instance: Online Password Resetting Fails or Invalid
API Documentation
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
Snapshot APIs
CCN APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
FAQs
Agreements
Privacy Policy
Data Processing And Security Agreement
Contact Us

DescribeFirewallRules

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-10-30 21:47:30

1. API Description

Domain name for API request: lighthouse.intl.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.intl.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.intl.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 You do not have permission to perform this operation. The token in the request is invalid.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan