Last updated: 2020-07-31 10:09:21

1. API Description

Domain name for API request:

This API is used to get a layer-7 forwarding rule.

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 parameter. The value used for this API: DescribleL7Rules.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Business Yes String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; net: Anti-DDoS Ultimate
Id Yes String Anti-DDoS instance ID
RuleIdList.N No Array of String Rule ID, which is optional. If this field is entered, the specified rule will be obtained
Limit No Integer Number of entries per page. A value of 0 means no pagination
Offset No Integer Page start offset, whose value is (page number - 1) * number of entries per page
Domain No String Domain name search, which is optional. Enter it if you need to search for domain names
ProtocolList.N No Array of String Forwarding protocol search, which is optional. Valid values: [http, https, http/https]
StatusList.N No Array of Integer Status search, which is optional. Valid values: [0 (successfully configured rule), 1 (rule configuration taking effect), 2 (rule configuration failed), 3 (rule deletion taking effect), 5 (rule deletion failed), 6 (rule waiting for configuration), 7 (rule waiting for deletion), 8 (rule waiting for certificate configuration)]

3. Output Parameters

Parameter Name Type Description
Rules Array of L7RuleEntry Forwarding rule list
Total Integer Total number of rules
Healths Array of L7RuleHealth Health check configuration list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting layer-7 forwarding rule

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Total": 1,
    "Rules": [
        "RuleId": "rule-00000002",
        "RuleName": "test",
        "Protocol": "http",
        "VirtualPort": 80,
        "SourcePort": 80,
        "SourceType": 2,
        "LbType": 1,
        "KeepTime": 300,
        "SourceList": [
            "Source": "",
            "Weight": 50
            "Source": "",
            "Weight": 50
  "Healths": [
      "RuleId": "rule-00000001",
      "Enable": 1,
      "Interval": 300,
      "KickNum": 2,
      "AliveNum": 2,
      "Method": "HEAD",
      "StatusCode": 15,
      "Url": "/index.php",
      "Status": 1

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback