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

1. API Description

Domain name for API request:

This API is used to get the exception result of a layer-4 forwarding rule health check.

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 parameter. The value used for this API: DescribeL4RulesErrHealth.
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

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of exceptional rules
ErrHealths Array of KeyValue Exceptional rule list. Returned value description: Key is the rule ID, while Value is the exceptional IP. Multiple IPs are separated by ","
ExtErrHealths Array of KeyValueRecord Exceptional rule list (which provides more error-related information). Returned value description:
If key is RuleId, Value indicates the rule ID;
If key is Protocol, Value indicates the forwarding protocol of a rule;
If key is VirtualPort, Value indicates the forwarding port of a rule;
If Key is ErrMessage, Value indicates the exception message for health check;
Exception message for health check in the format of "SourceIp:|SourcePort:1234|AbnormalStatTime:1570689065|AbnormalReason:connection time out|Interval:20|CheckNum:6|FailNum:6". Multiple error messages for the source IP should be separated by ,,
SourceIp: real server IP, SourcePort: real server port, AbnormalStatTime: exception time, AbnormalReason: cause of exception, Interval: check frequency, CheckNum: number of checks, FailNum: number of failures;
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the exception result of layer-4 forwarding rule health check

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Total": 1,
    "ErrHealths": [
        "Key": "rule-00000001",
        "Value": ","
    "ExtErrHealths": [
        "Record": [
            "Key": "RuleId",
            "Value": "rule-00000001"
            "Key": "Protocol",
            "Value": "TCP"
            "Key": "VirtualPort",
            "Value": "1234"
            "Key": "ErrMessage",
            "Value": "SourceIp:|SourcePort:1234|AbnormalStatTime:1570689065|AbnormalReason:connection time out|Interval:20|CheckNum:6|FailNum:6,SourceIp:|SourcePort:1234|AbnormalStatTime:1570689065|AbnormalReason:connection time out|Interval:20|CheckNum:6|FailNum:6"

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