1. 接口描述
接口请求域名: bma.tencentcloudapi.com 。
查询白名单列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBPWhiteLists。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-15。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 过滤参数 |
PageSize | 否 | Integer | 页数 |
PageNumber | 否 | Integer | 页码 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WhiteLists | Array of WhiteListData | 白名单列表 |
TotalCount | Integer | 白名单总数 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询白名单列表
查询白名单列表
输入示例
POST / HTTP/1.1
Host: bma.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBPWhiteLists
<公共请求参数>
{
"Filters": [
{
"Name": "CompanyId",
"Value": "123"
},
{
"Name": "AssetsType",
"Value": "0"
},
{
"Name": "WhiteList",
"Value": "白名单名称"
},
{
"Name": "StartTime",
"Value": "2022-10-01 00:00:00"
},
{
"Name": "EndTime",
"Value": "2022-10-01 23:59:59"
}
],
"PageSize": 10,
"PageNumber": 1
}
输出示例
{
"Response": {
"WhiteLists": [
{
"WhiteListId": 123,
"CompanyId": 123,
"BrandName": "品牌名称",
"AssetsType": 0,
"WhiteList": "白名单名称",
"InsertTime": "2022-10-01 00:00:00"
}
],
"TotalCount": 10,
"RequestId": "xxx"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.CompanyNameWrong | 操作失败,企业名称有误。 |
FailedOperation.ExistCompany | 操作失败,已存在企业信息。 |
FailedOperation.ExistDetectTarget | 操作失败,已存在检测对象。 |
FailedOperation.ExistSoftware | 操作失败,已存在软件信息。 |
FailedOperation.ReuseResource | 该资源已使用,请勿重复使用。 |
FailedOperation.SmsVerify | 操作失败,验证码错误。 |
FailedOperation.UnusableResource | 操作失败,资源不可用。 |
InternalError | 内部错误。 |
InternalError.SmsVerify | 服务暂时不可用,请稍后重试。若无法解决,请联系智能客服。 |
InvalidAction | 接口不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameter.PrivacyTextIsNotUtf8 | 无效的隐私文本,请使用规定方法上传UTF-8编码格式文件。 |
InvalidParameter.PrivacyTextURL | 无效的隐私文本下载链接,请使用规定方法上传文件。 |
InvalidParameter.SoftwareURL | 无效的软件下载链接,请使用规定方法上传文件。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
NoSuchVersion | 接口版本不存在。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedRegion | 接口不支持所传地域。 |