1. 接口描述
接口请求域名： cwp.api3.fincloud.tencent.cn。
获取阻断按钮状态
默认接口请求频率限制：20次/秒。
接口更新时间：2022-05-20 15:12:33。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBanStatus |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-02-28 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OpenSmartMode | Bool | 是否开启智能过白模式 示例值： true |
| ShowTips | Bool | 是否弹窗提示信息 false: 关闭，true: 开启 示例值： false |
| Status | Uint64 | 阻断开关状态: 0 -- 关闭 1 -- 高级阻断 2 -- 基础阻断(只阻断情报库黑ip) 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |