调用此接口，可获取 NAT 边界防火墙实例信息，包括实例 ID、实例名称、网关 ID、网关名称等信息。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeNatFirewallList | 接口名称。当前 API 的名称为 DescribeNatFirewallList。 |
| Version | String | 是 | 2021-09-06 | 接口版本。当前 API 的版本为 2021-09-06。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
FirewallStatus | Array of String | 否 |
| NAT边界防火墙实例的状态，可能的取值如下所示。
|
| NatFirewallId | String | 否 | nfw-******** | NAT边界防火墙实例 ID，获取方式可参考DescribeNatFirewallList - 查询 NAT 边界防火墙实例列表。 |
| NatFirewallName | String | 否 | NatFirewallName | NAT 边界防火墙实例的名称，获取方式可参考DescribeNatFirewallList - 查询 NAT 边界防火墙实例列表。 |
| NatGatewayId | String | 否 | ngw-******** | NAT 网关的唯一标识符，用于指定查询的 NAT 网关。 |
| NatGatewayName | String | 否 | NatGatewayName | NAT 网关的名称，用于标识查询的 NAT 网关。 |
| PageNumber | Integer | 否 | 1 | 分页页码，默认值为 1。 |
| PageSize | Integer | 否 | 10 | 分页大小，默认值为 10。 |
| RegionCode | Array of String | 否 | ["cn-beijing"] | 实例所属地域，支持多选。 |
| VpcId | String | 否 | vpc-******** | VPC 的唯一标识符，用于指定查询的虚拟私有云。 |
| VpcName | String | 否 | VpcName | 虚拟私有云的名称，用于标识查询的虚拟私有云。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Count | Integer | 10 | 当前页面返回的 NAT 防火墙实例数量。 |
| Data | Array of NatFirewallDetail | -- | NAT 防火墙实例详情。 |
| PageNumber | Integer | 1 | 返回数据的分页页码，表示当前查询结果所在的页码。 |
| PageSize | Integer | 10 | 返回数据的分页大小，表示每页显示的 NAT 防火墙实例数量。 |
| TotalCount | Integer | 12 | 返回的 NAT 边界防火墙实例总量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| VpcId | String | vpc-12345678 | VPC 的唯一标识符，用于标识 NAT 边界防火墙实例所属的虚拟私有云。 |
| Region | String | cn-beijing | NAT 边界防火墙实例所属的地域，用于标识实例所在的物理位置。 |
| ZoneId | String | cn-guilin-c | NAT 边界防火墙实例所在的可用区，用于标识实例部署的具体物理区域。 |
| VpcCidr | String | 180.0.0.0/16 | 虚拟私有云（VPC）的网段地址，用于标识该 VPC 的 IP 地址范围。 |
| VpcName | String | MyVPC | 虚拟私有云（VPC）的名称，用于标识该 VPC 的易读名称。 |
| AccountId | String | 2100052*** | 用户的唯一标识符，用于标识该 NAT 边界防火墙实例所属的账户。 |
| Bandwidth | Integer | 10 | NAT 边界防火墙实例的授权流量带宽，单位为 Mbps，表示该防火墙实例允许的最大网络带宽。 |
| CanCreate | Boolean | true | 标识当前是否支持创建 NAT 边界防火墙。返回值为布尔类型，true 表示支持创建，false 表示不支持。 |
| ErrMessage | String | NAT 边界防火墙实例已达到配额限制 | 当创建或查询 NAT 边界防火墙实例时发生错误时返回的错误信息，用于描述具体的错误原因。 |
| NatGatewayId | String | ngw-12345678 | 与 NAT 边界防火墙实例关联的 NAT 网关的唯一标识符，用于标识该防火墙实例所保护的 NAT 网关。 |
| NatFirewallId | String | nfw-12345678 | NAT 边界防火墙实例的唯一标识符，用于唯一标识一个 NAT 边界防火墙实例。 |
FirewallStatus | String |
| NAT边界防火墙实例的状态，可能的取值如下所示。
|
| NatGatewayName | String | NatGatewayName | NAT 网关的名称，用于标识查询的 NAT 网关。 |
| NatFirewallName | String | NatFirewallName | NAT 边界防火墙实例的名称，用于标识该防火墙实例的易读名称。 |
| PeakTrafficWithin7Day | Integer | 16998336 | NAT 边界防火墙实例在过去 7 天内的流量峰值，单位为 bps，用于监控网络流量的最高使用情况。 |
POST https://fw_center.volcengineapi.com/?Action=DescribeNatFirewallList&Version=2021-09-06 { "FirewallStatus": [ "" ], "NatFirewallId": "nfw-********", "NatFirewallName": "NatFirewallName", "NatGatewayId": "ngw-********", "NatGatewayName": "NatGatewayName", "PageNumber": 1, "PageSize": 10, "RegionCode": [ "cn-beijing" ], "VpcId": "vpc-********", "VpcName": "VpcName" }
{ "ResponseMetadata": { "Action": "DescribeNatFirewallList", "Region": "cn-beijing", "Service": "fw_center", "Version": "2021-09-06", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Count": 1, "Data": [ { "VpcId": "vpc-********", "Region": "cn-beijing", "ZoneId": "cn-guilin-c", "VpcCidr": "180.*.*.1/16", "VpcName": "VpcName", "AccountId": "2100052***", "Bandwidth": 10, "CanCreate": true, "ErrMessage": "ErrMessage", "NatGatewayId": "ngw-********", "NatFirewallId": "nfw-********", "FirewallStatus": "opened", "NatGatewayName": "Nat***", "NatFirewallName": "Nat云防火墙1", "PeakTrafficWithin7Day": 16998336 } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 1 } }
您可访问公共错误码，获取更多错误码信息。