获取L7转发规则

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

1. 接口描述

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

获取七层转发规则

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribleL7Rules
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(bgpip表示高防IP;bgp表示独享包;bgp-multip表示共享包;net表示高防IP专业版)
Id String 资源ID
RuleIdList.N Array of String 规则ID,可选参数,填写后获取指定的规则
Limit Integer 一页条数,填0表示不分页
Offset Integer 页起始偏移,取值为(页码-1)*一页条数
Domain String 域名搜索,选填,当需要搜索域名请填写
ProtocolList.N Array of String 转发协议搜索,选填,取值[http, https, http/https]
StatusList.N Array of Integer 状态搜索,选填,取值[0(规则配置成功),1(规则配置生效中),2(规则配置失败),3(规则删除生效中),5(规则删除失败),6(规则等待配置),7(规则等待删除),8(规则待配置证书)]

3. 输出参数

参数名称 类型 描述
Rules Array of L7RuleEntry 转发规则列表
Total Integer 总规则数
Healths Array of L7RuleHealth 健康检查配置列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取L7转发规则

输入示例

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

输出示例

{
  "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": "2.1.1.1",
            "Weight": 50
          },
          {
            "Source": "2.1.1.2",
            "Weight": 50
          }
        ]
      }
    ]
  },
  "Healths": [
    {
      "RuleId": "rule-00000001",
      "Enable": 1,
      "Interval": 300,
      "KickNum": 2,
      "AliveNum": 2,
      "Method": "HEAD",
      "StatusCode": 15,
      "Url": "/index.php",
      "Status": 1
    }
  ]
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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