DescribeBlackWhiteQuota
最近更新时间: 2025-10-20 17:06:06
1. 接口描述
接口请求域名： cfw.api3.fincloud.tencent.cn。
查询黑白名单配额总接口
默认接口请求频率限制：10000次/秒。
接口更新时间：2023-07-03 19:19:53。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBlackWhiteQuota |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-04 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExpandBlackList | Uint64 | 此参数对外不可见。 黑名单扩容配额 |
| MaxImportQuotaBlackList | Uint64 | 此参数对外不可见。 最大导出黑名单 |
| MaxImportQuotaWhiteList | Uint64 | 此参数对外不可见。 最大导出白名单 |
| NeedQuotaBlackList | Uint64 | 此参数对外不可见。 黑名单需要配额 |
| RemainQuotaBlackList | Uint64 | 此参数对外不可见。 黑名单剩余配额 |
| RemainQuotaWhiteList | Uint64 | 此参数对外不可见。 白名单剩余配额 |
| ReturnCode | Int64 | 此参数对外不可见。 0成功 非0 失败 |
| ReturnMsg | String | 此参数对外不可见。 success 成功 其他失败 |
| TotalQuotaBlackList | Uint64 | 此参数对外不可见。 黑名单总配额 |
| TotalQuotaWhiteList | Uint64 | 此参数对外不可见。 白名单总配额 |
| UsedBlackList | Uint64 | 此参数对外不可见。 黑名单已使用配额 |
| UsedWhiteList | Uint64 | 此参数对外不可见。 白名单已使用配额 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnknownParameter | 未知参数错误。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制 |
| ResourcesSoldOut | 资源售罄。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| AuthFailure | CAM签名/鉴权错误 |
| OperationDenied | 操作被拒绝。 |
| ResourceUnavailable | 资源不可用。 |
| UnsupportedOperation | 操作不支持。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation | 未授权操作。 |
| ResourceNotFound | 资源不存在。 |