API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > DDoS 防护 > 防护配置相关接口 > 获取CC四层黑白名单列表

获取CC四层黑白名单列表

最近更新时间：2024-03-12 01:07:58

我的收藏

本页目录：

1. 接口描述

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

获取CC四层黑白名单列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCcBlackWhiteIpList。
Version 是 String 公共参数，本接口取值：2020-03-09。
Region 否 String 公共参数，本接口不需要传递此参数。
Business 是 String DDoS防护子产品代号（bgp-multip：表示高防包；bgpip：表示高防IP）
示例值：bgp-multip
InstanceId 是 String 指定特定实例Id
示例值：bgpip-0000011x
Offset 是 Integer 页起始偏移，取值为(页码-1)*一页条数
示例值：1
Limit 是 Integer 一页条数
示例值：1
Ip 否 String IP地址，普通高防IP要传该字段
示例值：1.1.1.1
Domain 否 String 域名，普通高防IP要传该字段
示例值：www.xx.com
Protocol 否 String 协议，普通高防IP要传该字段
示例值：http
FilterIp 否 String 筛选IP，需要筛选黑白名单IP时传该字段
示例值：1.1.1.1
FilterType 否 String 黑白名单筛选字段，需要筛选黑白名单列表时传该字段
示例值：black

3. 输出参数

参数名称 类型 描述
Total Integer CC四层黑白名单策略列表总数
示例值：1
CcBlackWhiteIpList Array of CcBlackWhiteIpPolicy CC四层黑白名单策略列表详情
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取CC四层黑白名单列表

输入示例

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

{
    "Domain": "www.test1.com",
    "Protocol": "https",
    "Business": "bgpip",
    "InstanceId": "bgpip-000000z9",
    "Ip": "1.1.1.1",
    "Limit": 1,
    "Offset": 1
}

输出示例

{
    "Response": {
        "Total": 1,
        "CcBlackWhiteIpList": [
            {
                "Domain": "www.test1.com",
                "BlackWhiteIp": "2.2.2.2",
                "Protocol": "https",
                "InstanceId": "bgpip-000004z9",
                "Ip": "1.1.1.1",
                "Mask": 1,
                "PolicyId": "ccBlackWhite-000002s7",
                "ModifyTime": "2022-04-30 08:09:20",
                "Type": "white",
                "CreateTime": "2022-04-30 07:09:20"
            }
        ],
        "RequestId": "1be9f39c-7060-11ed-aae2-525400f921f0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
LimitExceeded 超过配额限制。
ResourceUnavailable 资源不可用。
UnsupportedOperation 操作不支持。
中国站