tencent cloud

Feedback

DescribeFirewallRulesTemplate

Last updated: 2022-09-26 17:00:23

1. API Description

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

This API is used to query a firewall rule template.

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: DescribeFirewallRulesTemplate.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.

3. Output Parameters

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

4. Example

Example1 Querying a firewall rule template

Input Example

https://lighthouse.tencentcloudapi.com/?Action=DescribeFirewallRulesTemplate
&<Common request parameters>

Output Example

{
    "Response": {
        "FirewallRuleSet": [
            {
                "Action": "ACCEPT",
                "AppType": "Windows login (3389)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow Windows remote login",
                "Port": "3389",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "Linux login (22)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow Linux SSH login",
                "Port": "22",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "HTTP(80)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow web service HTTP (80), such as Apache and Nginx",
                "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"
            },
            {
                "Action": "ACCEPT",
                "AppType": "MySQL(3306)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow MySQL service (3306)",
                "Port": "3306",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "SQL Server(1433)",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow SQL Server service (1433)",
                "Port": "1433",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "All TCP ports",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow all TCP ports",
                "Port": "1-65535",
                "Protocol": "TCP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "All UDP ports",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "All all UDP ports",
                "Port": "1-65535",
                "Protocol": "UDP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "Ping-ICMP",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow Ping",
                "Port": "ALL",
                "Protocol": "ICMP"
            },
            {
                "Action": "ACCEPT",
                "AppType": "ALL",
                "CidrBlock": "0.0.0.0/0",
                "FirewallRuleDescription": "Allow all TCP, UDP, ICMP (Ping), and GRE ports",
                "Port": "ALL",
                "Protocol": "ALL"
            }
        ],
        "RequestId": "b9fdb7cc-8afa-4fae-9062-73e41d06f7d3",
        "TotalCount": 10
    }
}

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
UnauthorizedOperation.NoPermission No permission
Contact Us

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

Technical Support

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

7x24 Phone Support