1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
访问控制列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAcLists。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Protocol | 否 | String | 协议 示例值：TCP |
| Strategy | 否 | String | 策略 |
| SearchValue | 否 | String | 搜索值 |
| Limit | 否 | Integer | 每页条数 示例值：20 |
| Offset | 否 | Integer | 偏移值 示例值：0 |
| Direction | 否 | Integer | 出站还是入站，1：入站，0：出站 示例值：1 |
| EdgeId | 否 | String | EdgeId值 |
| Status | 否 | String | 规则是否开启，'0': 未开启，'1': 开启, 默认为'0' |
| Area | 否 | String | 地域 |
| InstanceId | 否 | String | 实例ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总条数 示例值：1 |
| Data | Array of AcListsData | 访问控制列表数据 |
| AllTotal | Integer | 不算筛选条数的总条数 示例值：1 |
| Enable | Integer | 访问控制规则全部启用/全部停用 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 访问控制列表
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAcLists
<公共请求参数>
{
"EdgeId": "",
"Protocol": "TCP",
"Strategy": "",
"SearchValue": "",
"Direction": 1,
"Limit": 20,
"Offset": 0,
"Area": ""
}输出示例
{
"Response": {
"AllTotal": 1,
"Total": 1,
"Data": [
{
"Count": 1,
"Protocol": "xx",
"Detail": "xx",
"Strategy": 1,
"LogId": "xx",
"OrderIndex": 1,
"TargetIp": "xx",
"Port": "xx",
"SourceIp": "xx",
"Id": 1
}
],
"Enable": 1,
"RequestId": "xx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| UnauthorizedOperation | 未授权操作。 |