1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询当前租户的 ACL 用户访问控制规则列表。传入 Filter.Name=RuleID 可精确查询单条规则(用于详情页面场景)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSandboxACLRuleList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Offset | 否 | Integer | 偏移量,默认 0 示例值:0 |
| Limit | 否 | Integer | 每页数量,默认 10,上限 200 示例值:10 |
| Filters.N | 否 | Array of Filters | 过滤条件 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-7*ef"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of TrafficSandboxACLRuleInfo | 规则列表 |
| TotalCount | Integer | 总数量 示例值:15 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 ACL 规则列表示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSandboxACLRuleList
<公共请求参数>
{
"Filters": [
{
"Name": "Status",
"Values": [
"ON"
]
}
],
"MemberId": [
"mem-tencent-7*************ef"
]
}
输出示例
{
"Response": {
"Data": [
{
"ID": 2001,
"RuleName": "禁止出站访问未知域名",
"Level": "HIGH",
"Status": "ON",
"BelongAssetType": "HOST",
"SystemRuleContent": [
{
"DstRule": {
"DstIP": [
"10.10.20.30",
"172.16.0.0/16"
],
"DstIPExcept": [
"10.10.20.100"
],
"DstPort": [
"443",
"8080-8090"
],
"DstPortExcept": [
"22"
]
},
"URLRule": {
"URL": [
"*.example.com",
"api.example.com/v1/*"
],
"URLExcept": [
"test.example.com"
],
"Protocol": [
"http",
"https"
],
"Method": [
"GET",
"POST"
]
}
}
],
"UserRuleContent": [
{
"DstRule": {
"DstIP": [
"10.10.20.30",
"172.16.0.0/16"
],
"DstIPExcept": [
"10.10.20.100"
],
"DstPort": [
"443",
"8080-8090"
],
"DstPortExcept": [
"22"
]
},
"URLRule": {
"URL": [
"*.example.com",
"api.example.com/v1/*"
],
"URLExcept": [
"test.example.com"
],
"Protocol": [
"http",
"https"
],
"Method": [
"GET",
"POST"
]
}
}
],
"EffectScope": {
"EffectType": "INCLUDE",
"EffectAssets": [
{
"InstanceId": "ins-a1b2c3d4",
"ContainerId": "docker-container-abc123"
}
]
},
"InactiveAssets": [
{
"InstanceId": "ins-a1b2c3d4",
"ContainerId": "",
"TrafficPluginState": {
"InstallStatus": "INSTALL_FAIL",
"Status": "IPTABLE_FAILED",
"Message": "iptables 规则下发失败",
"ActivityTime": "2025-03-19T10:35:00+08:00"
}
}
],
"InsertTime": "2025-01-01T10:00:00+08:00",
"UpdateTime": "2025-03-15T14:30:00+08:00",
"RuleAction": "BLOCK"
}
],
"TotalCount": 15,
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。