1. 接口描述接口请求域名： bh.tencentcloudapi.com 。
查询访问白名单规则列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
参数名称
必选
类型
描述
Action
是
String
公共参数，本接口取值：DescribeAccessWhiteListRules。
Version
是
String
公共参数，本接口取值：2023-04-18。
Region
是
String
公共参数，详见产品支持的 地域列表。
IdSet.N
否
Array of Integer
用户ID集合，非必需，如果使用IdSet参数则忽略Name参数示例值：[1,2]
Name
否
String
来源IP或网段，模糊查询，最大长度64字符示例值：10.10.10.1
Offset
否
Integer
分页偏移位置，默认0示例值：0
Limit
否
Integer
每页条目数量，默认20示例值：10
3. 输出参数
参数名称
类型
描述
TotalCount
Integer
记录总数示例值：2
AccessWhiteListRuleSet
Array of AccessWhiteListRule
访问白名单规则列表示例值：[]
AllowAny
Boolean
是否放开全部来源IP，如果为true，TotalCount为0，AccessWhiteListRuleSet为空示例值：true
AllowAuto
Boolean
是否开启自动添加来源IP, 如果为true, 在开启访问白名单的情况下将自动添加来源IP示例值：true
RequestId
String
唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
4. 示例示例1 查询用户组列表，放开全部来源IP查询用户组列表，放开全部来源IP
输入示例
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessWhiteListRules
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 0,
"AccessWhiteListRuleSet": [],
"RequestId": "b8ebf0b3-ecf5-49bf-9f9d-86341c4072f1",
"AllowAny": true,
"AllowAuto": false
}
}
示例2 查询用户组列表，未放开全部来源IP查询用户组列表，未放开全部来源IP且开启自动添加IP
输入示例
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessWhiteListRules
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 1,
"AccessWhiteListRuleSet": [
{
"Source": "127.0.0.1",
"Remark": "",
"Id": 1,
"ModifyTime": "2020-09-22T00:00:00+00:00"
}
],
"RequestId": "b8ebf0b3-ecf5-49bf-9f9d-86341c4072f1",
"AllowAny": false,
"AllowAuto": true
}
}
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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
Tencent Cloud CLI 3.0
6. 错误码以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
错误码
描述
InternalError
内部错误。
InvalidParameter
参数错误。
InvalidParameterValue
参数取值错误。
ResourceNotFound
资源不存在。