1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(DescribeNetworkAcls)用于查询网络ACL列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNetworkAcls。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 过滤条件,参数不支持同时指定NetworkAclIds和Filters。 示例值:vpc-qw123456 |
NetworkAclIds.N | 否 | Array of String | 网络ACL实例ID数组。形如:[acl-12345678]。每次请求的实例的上限为100。参数不支持同时指定NetworkAclIds和Filters。 示例值:[acl-12345678] |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最小值为1,最大值为100。 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NetworkAclSet | Array of NetworkAcl | 实例详细信息列表。 |
TotalCount | Integer | 符合条件的实例数量。 示例值:1 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1 查询网络ACL列表
查询网络ACL列表
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetworkAcls
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 1,
"NetworkAclSet": [
{
"TagSet": [],
"NetworkAclId": "acl-kmxukyv6",
"VpcId": "vpc-9it989fn",
"NetworkAclType": "TRIPLE",
"IngressEntries": [
{
"Protocol": "all",
"Description": "测试1",
"Ipv6CidrBlock": "::/0",
"ModifyTime": "2020-01-21 14:26:22",
"Action": "Drop",
"CidrBlock": "0.0.0.0/0",
"Port": "80"
}
],
"SubnetSet": [
{
"NetworkAclId": "acl-kmxukyv6",
"RouteTableId": "rtb-we123456",
"VpcId": "vpc-rt123456",
"EnableBroadcast": true,
"Zone": "ap-guangzhou",
"Ipv6CidrBlock": "::/0",
"AvailableIpAddressCount": 1,
"IsRemoteVpcSnat": true,
"SubnetName": "子网1",
"TotalIpAddressCount": 1,
"IsCdcSubnet": 0,
"CdcId": "cluster-gbo27yc4",
"TagSet": [
{
"Value": "og",
"Key": "ck"
}
],
"CreatedTime": "2020-01-20 14:26:22",
"SubnetId": "subnet-qmqye6ew",
"CidrBlock": "10.0.0.0/24",
"IsDefault": true
}
],
"NetworkAclName": "测试001",
"CreatedTime": "2020-01-20 14:26:22",
"EgressEntries": [
{
"Protocol": "All",
"Description": "测试222",
"Ipv6CidrBlock": "::/0",
"ModifyTime": "2020-01-20 14:26:22",
"Action": "Drop",
"CidrBlock": "10.0.0.0/24",
"Port": "80"
}
]
}
],
"RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
}
}
示例2 示例2 根据条件查询网络ACL列表
根据条件查询网络ACL列表
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetworkAcls
<公共请求参数>
{
"NetworkAclIds": [
"acl-12345678"
],
"Limit": 20,
"Offset": 0
}
输出示例
{
"Response": {
"TotalCount": 1,
"NetworkAclSet": [
{
"TagSet": [],
"NetworkAclId": "",
"VpcId": "vpc-kj123456",
"NetworkAclType": "TRIPLE",
"IngressEntries": [
{
"Protocol": "all",
"Description": "测试1",
"Ipv6CidrBlock": "::/0",
"ModifyTime": "2020-01-21 14:26:22",
"Action": "Drop",
"CidrBlock": "0.0.0.0/0",
"Port": "80"
}
],
"SubnetSet": [
{
"NetworkAclId": "acl-kmxukyv6",
"RouteTableId": "rtb-we123456",
"VpcId": "vpc-kj123456",
"EnableBroadcast": true,
"Zone": "ap-guangzhou",
"Ipv6CidrBlock": "::/0",
"AvailableIpAddressCount": 1,
"IsCdcSubnet": 0,
"CdcId": "cluster-gbo27yc4",
"IsRemoteVpcSnat": true,
"SubnetName": "测试01",
"TotalIpAddressCount": 1,
"TagSet": [
{
"Value": "yt",
"Key": "kj"
}
],
"CreatedTime": "2020-01-21 14:26:22",
"SubnetId": "subnet-qmqye6ew",
"CidrBlock": "10.0.0.0/24",
"IsDefault": true
}
],
"NetworkAclName": "测试33",
"CreatedTime": "2020-01-21 14:26:22",
"EgressEntries": [
{
"Protocol": "All",
"Description": "测试",
"Ipv6CidrBlock": "::/0",
"ModifyTime": "2020-01-21 14:26:22",
"Action": "Drop",
"CidrBlock": "10.0.0.0/24",
"Port": "80"
}
]
}
],
"RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ModuleError | 内部模块错误。 |
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.ActionNotFound | 接口不存在。 |