API 文档

修改负载均衡的IP封禁黑名单列表

最近更新时间:2021-02-04 08:15:34

我的收藏

1. 接口描述

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

修改负载均衡的IP(client IP)封禁黑名单列表,一个转发规则最多支持封禁 2000000 个IP,及黑名单容量为 2000000。 (接口灰度中,如需使用请提工单)

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyBlockIPList。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerIds.N Array of String 负载均衡实例ID
Type String 操作类型,可取:
  • add_customized_field(首次设置header,开启黑名单功能)
  • set_customized_field(修改header)
  • del_customized_field(删除header)
  • add_blocked(添加黑名单)
  • del_blocked(删除黑名单)
  • flush_blocked(清空黑名单)
  • ClientIPField String 客户端真实IP存放的header字段名
    BlockIPList.N Array of String 封禁IP列表,单次操作数组最大长度支持200000
    ExpireTime Integer 过期时间,单位秒,默认值3600
    AddStrategy String 添加IP的策略,可取:fifo(如果黑名单容量已满,新加入黑名单的IP采用先进先出策略)

    3. 输出参数

    参数名称 类型 描述
    JodId String 异步任务的ID
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 设置header,开启黑名单功能

    使用封禁功能,需要先设置header,指定客户端真实IP存放的header字段名,开启黑名单功能。

    输入示例

    https://clb.tencentcloudapi.com/?Action=ModifyBlockIPList
    &LoadBalancerIds.0=lb-6efswuxa
    &Type=add_customized_field
    &ClientIPField=client_ip_test
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "JodId": "localjob010916173469001234512345",
        "RequestId": "83329908-a282-4f9f-82ab-033a30212345"
      }
    }

    示例2 添加黑名单

    指定客户端真实IP存放的header字段名,开启黑名单功能完成后,即可添加黑名单(删除黑名单、清空黑名单功能类似)

    输入示例

    https://clb.tencentcloudapi.com/?Action=ModifyBlockIPList
    &LoadBalancerIds.0=lb-6efswuxa
    &Type=add_blocked
    &BlockIPList.0=1.2.3.4
    &ExpireTime=3000
    &AddStrategy=fifo
    &ClientIPField=client_ip_test
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "JodId": "localjob010916173469001234567890",
        "RequestId": "83329908-a282-4f9f-82ab-033a3025baff"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.FormatError 参数格式错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Length 参数长度错误。
    MissingParameter 缺少参数错误。
    UnauthorizedOperation 未授权操作。
    目录