DDoS 防护
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > DDoS 防护 > API 文档 > 资产列表相关接口 > 高防IP获取7层规则

高防IP获取7层规则

最近更新时间：2024-03-12 01:08:02

我的收藏

本页目录：

1. 接口描述

接口请求域名： antiddos.tencentcloudapi.com 。

高防IP获取7层规则

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeNewL7Rules。
Version 是 String 公共参数，本接口取值：2020-03-09。
Region 否 String 公共参数，本接口不需要传递此参数。
Business 是 String DDoS防护子产品代号（bgpip表示高防IP）
示例值：bgpip
StatusList.N 否 Array of Integer 状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]
Domain 否 String 域名搜索，选填，当需要搜索域名请填写
Ip 否 String IP搜索，选填，当需要搜索IP请填写
示例值：1.1.1.1
Limit 否 Integer 一页条数，默认值100，最大值100，超过100最大返回100条
Offset 否 Integer 规则偏移量，取值为(页码-1)*一页条数
ProtocolList.N 否 Array of String 转发协议搜索，选填，取值[http, https, http/https]
Cname 否 String 高防IP实例的Cname
示例值：abcdefg
Export 否 Boolean 默认为false，当为true时，将不对各个规则做策略检查，直接导出所有规则

3. 输出参数

参数名称 类型 描述
Rules Array of NewL7RuleEntry 转发规则列表
Healths Array of L7RuleHealth 健康检查配置列表
Total Integer 总规则数
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取高防ip所有规则

获取高防ip所有规则

输入示例

POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNewL7Rules
<公共请求参数>

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

输出示例

{
    "Response": {
        "Rules": [
            {
                "Region": 1,
                "Id": "abc",
                "Ip": "abc",
                "RuleId": "abc",
                "RuleName": "abc",
                "Protocol": "abc",
                "Domain": "abc",
                "LbType": 1,
                "KeepEnable": 1,
                "KeepTime": 1,
                "SourceType": 1,
                "CertType": 1,
                "SSLId": "abc",
                "Cert": "abc",
                "PrivateKey": "abc",
                "SourceList": [
                    {
                        "Source": "abc",
                        "Weight": 1,
                        "Port": 1,
                        "Backup": 1
                    }
                ],
                "Status": 1,
                "CCStatus": 1,
                "CCEnable": 1,
                "CCThreshold": 1,
                "CCLevel": "abc",
                "ModifyTime": "2020-09-22 00:00:00",
                "HttpsToHttpEnable": 1,
                "VirtualPort": 1,
                "RewriteHttps": 1,
                "ErrCode": 1,
                "Version": 1
            }
        ],
        "Healths": [
            {
                "Status": 1,
                "Enable": 1,
                "RuleId": "abc",
                "Url": "abc",
                "Interval": 1,
                "AliveNum": 1,
                "KickNum": 1,
                "Method": "abc",
                "StatusCode": 1,
                "ProtocolFlag": 1,
                "PassiveEnable": 1,
                "BlockInter": 1,
                "FailedCountInter": 1,
                "FailedThreshold": 1,
                "PassiveStatusCode": 1,
                "PassiveStatus": 1
            }
        ],
        "Total": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
中国站