获取CC的IP黑白名单

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

1. 接口描述

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

获取CC的IP黑白名单

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCCIpAllowDeny
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(bgpip表示高防IP;bgp表示独享包;bgp-multip表示共享包;net表示高防IP专业版)
Id String 资源ID
Type.N Array of String 黑或白名单,取值[white(白名单),black(黑名单)]
注意:此数组只能有一个值,不能同时获取黑名单和白名单
Limit Integer 分页参数
Offset Integer 分页参数
Protocol String 可选,代表HTTP协议或HTTPS协议的CC防护,取值[http(HTTP协议的CC防护),https(HTTPS协议的CC防护)];

3. 输出参数

参数名称 类型 描述
Data Array of KeyValue 该字段被RecordList字段替代了,请不要使用
Total Integer 记录数
RecordList Array of KeyValueRecord 返回黑/白名单的记录,
"Key":"ip"时,"Value":值表示ip;
"Key":"domain"时, "Value":值表示域名;
"Key":"type"时,"Value":值表示黑白名单类型(white为白名单,block为黑名单);
"Key":"protocol"时,"Value":值表示CC防护的协议(http或https);
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取CC的IP黑白名单

输入示例

https://dayu.tencentcloudapi.com/?Action=DescribeCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Type.0=black
&Protocol=http
&<公共请求参数>

输出示例

{
  "Response": {
    "Data": [
      {
        "Key": "white",
        "Value": "123.20.10.0/24,1.1.11.1"
      },
      {
        "Key": "total",
        "Value": "2"
      }
    ],
    "RecordList": [
      {
        "Record": [
          {
            "Key": "ip",
            "Value": "123.20.10.0/24"
          },
          {
            "Key": "domain",
            "Value": ""
          },
          {
            "Key": "protocol",
            "Value": "http"
          },
          {
            "Key": "type",
            "Value": "white"
          }
        ]
      },
      {
        "Record": [
          {
            "Key": "ip",
            "Value": "1.1.11.1"
          },
          {
            "Key": "domain",
            "Value": ""
          },
          {
            "Key": "protocol",
            "Value": "http"
          },
          {
            "Key": "type",
            "Value": "white"
          }
        ]
      }
    ],
    "RequestId": "40fc168e-a7c1-4bdc-92b9-d5b3f88369a9",
    "Total": 2
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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