文档中心 BGP 高防包 API 文档 接入配置相关接口 获取L4转发规则健康检查异常结果

获取L4转发规则健康检查异常结果

最近更新时间:2019-11-22 11:06:43

1. 接口描述

接口请求域名: dayu.tencentcloudapi.com 。

获取L4转发规则健康检查异常结果

默认接口请求频率限制:10次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeL4RulesErrHealth
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(bgpip表示高防IP;net表示高防IP专业版)
Id String 资源ID

3. 输出参数

参数名称 类型 描述
Total Integer 异常规则的总数
ErrHealths Array of KeyValue 异常规则列表,返回值说明: Key值为规则ID,Value值为异常IP,多个IP用","分割
ExtErrHealths Array of KeyValueRecord 异常规则列表(提供更多的错误相关信息),返回值说明:
Key值为RuleId时,Value值为规则ID;
Key值为Protocol时,Value值为规则的转发协议;
Key值为VirtualPort时,Value值为规则的转发端口;
Key值为ErrMessage时,Value值为健康检查异常信息;
健康检查异常信息的格式为"SourceIp:1.1.1.1|SourcePort:1234|AbnormalStatTime:1570689065|AbnormalReason:connection time out|Interval:20|CheckNum:6|FailNum:6" 多个源IP的错误信息用,分割,
SourceIp表示源站IP,SourcePort表示源站端口,AbnormalStatTime表示异常时间,AbnormalReason表示异常原因,Interval表示检查周期,CheckNum表示检查次数,FailNum表示失败次数;
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取L4转发规则健康检查异常结果

输入示例

https://dayu.tencentcloudapi.com/?Action=DescribeL4RulesErrHealth
&Business=bgpip
&Id=bgpip-000000xe
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码