tencent cloud

All product documents
Anti-DDoS
Documentation Anti-DDoSAPI DocumentationResource List APIsDescribeNewL7Rules
DescribeNewL7Rules
Download PDF
Last updated: 2025-04-01 16:03:57
DescribeNewL7Rules
Last updated: 2025-04-01 16:03:57
Download PDF

1. API Description

Domain name for API request: antiddos.intl.tencentcloudapi.com.

This API is used to obtain layer-7 forwarding rules.

A maximum of 20 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: DescribeNewL7Rules.
Version Yes String Common Params. The value used for this API: 2020-03-09.
Region No String Common Params. This parameter is not required for this API.
Business Yes String Anti-DDoS service type (bgpip: Anti-DDoS Advanced)
StatusList.N No Array of Integer (Optional) Searches by rule status. Valid values: 0 (Successfully configured), 1 (Being configured), 2 (Configuration failed), 3 (Being deleted), 5 (Deletion failed), 6 (awaiting configuration), 7 (awaiting deletion), and 8 (awaiting certificate configuration).
Domain No String (Optional) Searches by domain name.
Ip No String (Optional) Searches by IP.
Limit No Integer Number of items in a page. Returned results are not paged if you enter “0”.
Offset No Integer Starting offset of the page. Value: (number of pages – 1) * items per page.
ProtocolList.N No Array of String (Optional) Searches by forwarding protocol. Values: [http, https, http/https]
Cname No String CNAME of the Anti-DDoS Advanced instance

3. Output Parameters

Parameter Name Type Description
Rules Array of NewL7RuleEntry List of forwarding rules
Healths Array of L7RuleHealth List of health check settings
Total Integer Total number of rules
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining layer-7 forwarding rules

Input Example

POST / HTTP/1.1
Host: antiddos.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNewL7Rules
<Common request parameters>

{
    "StatusList": [
        1
    ],
    "Domain": "xx",
    "Business": "xx",
    "Ip": "xx",
    "Limit": 1,
    "Offset": 1,
    "ProtocolList": [
        "xx"
    ]
}

Output Example

{
    "Response": {
        "Rules": [
            {
                "KeepTime": 1,
                "HttpsToHttpEnable": 1,
                "Status": 1,
                "LbType": 1,
                "CCLevel": "xx",
                "CCEnable": 1,
                "CCThreshold": 1,
                "Region": 1,
                "VirtualPort": 1,
                "SourceList": [
                    {
                        "Source": "xx",
                        "Weight": 1
                    },
                    {
                        "Source": "xx",
                        "Weight": 1
                    }
                ],
                "Cert": "xx",
                "KeepEnable": 1,
                "ModifyTime": "2020-09-22 00:00:00",
                "Domain": "xx",
                "Protocol": "xx",
                "SourceType": 1,
                "RuleId": "xx",
                "Ip": "xx",
                "PrivateKey": "xx",
                "CertType": 1,
                "RuleName": "xx",
                "CCStatus": 1,
                "SSLId": "xx",
                "Id": "xx"
            }
        ],
        "Healths": [
            {
                "Status": 1,
                "Enable": 1,
                "RuleId": "xx",
                "Url": "xx",
                "Interval": 1,
                "AliveNum": 1,
                "KickNum": 1,
                "Method": "xx",
                "StatusCode":1,
            }
        ],
        "Total": 1,
        "RequestId": "xx"
    }
}

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
AuthFailure CAM signature/authentication error.
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 avaliable.

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