1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
查询NAT边界防火墙开关列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeNatFwSwitch。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 是 | Integer | 偏移量，分页用 示例值：0 |
| Limit | 是 | Integer | 条数，分页用 示例值：10 |
| Filters.N | 否 | Array of CommonFilter | 过滤条件组合 |
| Order | 否 | String | desc：降序；asc：升序。根据By字段的值进行排序，这里传参的话则By也必须有值 示例值：desc |
| By | 否 | String | 排序所用到的字段 示例值：id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| Data | Array of NatSwitchListData | NAT边界防火墙开关列表数据 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcList | Array of CommonIdName | 开关相关VPC列表 注意：此字段可能返回 null，表示取不到有效值。 |
| NatList | Array of CommonIdName | 开关相关NAT列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RouteList | Array of CommonIdName | 开关相关ROUTE列表 注意：此字段可能返回 null，表示取不到有效值。 |
| OnNum | Integer | 开启开关个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| OffNum | Integer | 关闭开关个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| FailData | Array of CommonIdNameStatus | 失败开关状态 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询NAT开关列表
查询NAT开关列表
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNatFwSwitch
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"Data": [
{
"Abnormal": 0,
"CvmNum": 1,
"Enable": 1,
"Id": 33781,
"NatId": "",
"NatInsId": "cfwnat-84d3440f",
"NatInsName": "[autotest][勿删]自动化测试",
"NatName": "",
"Region": "ap-shanghai",
"RouteId": "rtb-f5wqfibn",
"RouteName": "default_copy_for_cfw",
"Status": 0,
"SubnetCidr": "10.8.2.0/24",
"SubnetId": "subnet-j9cyo89p",
"SubnetName": "[autotest][勿删]自动化测试C2",
"VpcId": "vpc-d0t6wgo2",
"VpcName": "[autotest][勿删]自动化测试C"
},
{
"Abnormal": 0,
"CvmNum": 0,
"Enable": 1,
"Id": 34636,
"NatId": "",
"NatInsId": "cfwnat-84d3440f",
"NatInsName": "[autotest][勿删]自动化测试",
"NatName": "",
"Region": "ap-shanghai",
"RouteId": "rtb-l28qa73d",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "10.8.0.32/29",
"SubnetId": "subnet-rsun76k7",
"SubnetName": "防火墙专用子网_请勿删改",
"VpcId": "vpc-d0t6wgo2",
"VpcName": "[autotest][勿删]自动化测试C"
},
{
"Abnormal": 0,
"CvmNum": 0,
"Enable": 1,
"Id": 33779,
"NatId": "",
"NatInsId": "cfwnat-84d3440f",
"NatInsName": "[autotest][勿删]自动化测试",
"NatName": "",
"Region": "ap-shanghai",
"RouteId": "rtb-l28qa73d",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "10.8.3.0/24",
"SubnetId": "subnet-nem8hqnp",
"SubnetName": "MYSQL",
"VpcId": "vpc-d0t6wgo2",
"VpcName": "[autotest][勿删]自动化测试C"
},
{
"Abnormal": 0,
"CvmNum": 1,
"Enable": 1,
"Id": 33780,
"NatId": "",
"NatInsId": "cfwnat-84d3440f",
"NatInsName": "[autotest][勿删]自动化测试",
"NatName": "",
"Region": "ap-shanghai",
"RouteId": "rtb-l28qa73d",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "10.8.1.0/24",
"SubnetId": "subnet-jy2eionr",
"SubnetName": "[autotest][勿删]自动化测试C1",
"VpcId": "vpc-d0t6wgo2",
"VpcName": "[autotest][勿删]自动化测试C"
},
{
"Abnormal": 0,
"CvmNum": 0,
"Enable": 0,
"Id": 34637,
"NatId": "",
"NatInsId": "cfwnat-7e170f6b",
"NatInsName": "test",
"NatName": "",
"Region": "ap-beijing",
"RouteId": "rtb-o18lgl2l",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "10.0.0.0/24",
"SubnetId": "subnet-s1c8r185",
"SubnetName": "nat防火墙临时测试",
"VpcId": "vpc-0iz7ii4s",
"VpcName": "nat防火墙临时测试"
},
{
"Abnormal": 0,
"CvmNum": 0,
"Enable": 1,
"Id": 34629,
"NatId": "nat-de74cic7",
"NatInsId": "cfwnat-01debc37",
"NatInsName": "111",
"NatName": "test1",
"Region": "ap-shanghai",
"RouteId": "rtb-pslbu0gx",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "172.20.0.0/24",
"SubnetId": "subnet-8jm78x87",
"SubnetName": "subnet1",
"VpcId": "vpc-fmprtmz2",
"VpcName": "dora1"
},
{
"Abnormal": 0,
"CvmNum": 0,
"Enable": 0,
"Id": 34633,
"NatId": "nat-56jjs6mo",
"NatInsId": "cfwnat-49f38b8b",
"NatInsName": "测试接入",
"NatName": "gltest",
"Region": "ap-guangzhou",
"RouteId": "rtb-pwcv5gaw",
"RouteName": "default",
"Status": 0,
"SubnetCidr": "10.10.0.0/24",
"SubnetId": "subnet-7z6dhany",
"SubnetName": "fengqqiansub",
"VpcId": "vpc-0nduhuff",
"VpcName": "fengqqian-串行"
}
],
"FailData": [],
"NatList": [
{
"Id": "nat-56jjs6mo",
"Name": "gltest"
},
{
"Id": "nat-de74cic7",
"Name": "test1"
}
],
"OffNum": 2,
"OnNum": 5,
"RequestId": "2c74b129-10ea-434a-8e02-b125b9c3236b",
"RouteList": [
{
"Id": "rtb-f5wqfibn",
"Name": "default_copy_for_cfw"
},
{
"Id": "rtb-l28qa73d",
"Name": "default"
},
{
"Id": "rtb-o18lgl2l",
"Name": "default"
},
{
"Id": "rtb-pslbu0gx",
"Name": "default"
},
{
"Id": "rtb-pwcv5gaw",
"Name": "default"
}
],
"Total": 7,
"VpcList": [
{
"Id": "vpc-0iz7ii4s",
"Name": "nat防火墙临时测试"
},
{
"Id": "vpc-0nduhuff",
"Name": "fengqqian-串行"
},
{
"Id": "vpc-d0t6wgo2",
"Name": "[autotest][勿删]自动化测试C"
},
{
"Id": "vpc-fmprtmz2",
"Name": "dora1"
}
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
