1. 接口描述
接口请求域名: clb.api3.gsesgpucloud.com。
查询一个负载均衡所封禁的IP列表(黑名单)。(接口灰度中,如需使用请提工单)
默认接口请求频率限制:20次/秒。
接口更新时间:2020-01-10 20:22:50。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeBlockIPList |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
LoadBalancerId | 是 | 否 | String | 负载均衡实例 ID。 示例值: lb-a3u5**** |
Offset | 否 | 否 | Uint64 | 数据偏移量,默认为 0。 示例值: 0 |
Limit | 否 | 否 | Uint64 | 返回IP的最大个数,默认为 100000。 示例值: 20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BlockedIPCount | Uint64 | 返回的IP的数量 示例值: 3 |
ClientIPField | String | 获取用户真实IP的字段 示例值: shanghai |
BlockedIPList | BlockedIP | 加入了12360黑名单的IP列表 示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误 |
InternalError | 内部错误 |
UnauthorizedOperation | 未授权操作 |
FailedOperation | 操作失败 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.Length | 参数长度错误。 |