DescribeNatFirewallList - 查询 NAT 边界防火墙实例列表--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeNatFirewallList - 查询 NAT 边界防火墙实例列表

最近更新时间：2024.11.25 17:03:53首次发布时间：2024.11.24 23:48:55

调用此接口，可获取 NAT 边界防火墙实例信息，包括实例 ID、实例名称、网关 ID、网关名称等信息。

请求说明

请求方式：POST
请求地址：?Action=DescribeNatFirewallList&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeNatFirewallList`	接口名称。当前 API 的名称为 `DescribeNatFirewallList`。
Version	String	是	`2021-09-06`	接口版本。当前 API 的版本为 `2021-09-06`。

Body

参数	类型	是否必选	示例值	描述
FirewallStatus	Array of String	否	`opened`	NAT边界防火墙实例状态： creating：创建中 deleting：删除中 opened：已创建 closed：未创建 error：错误 updating：升级中
NatFirewallId	String	否	`nfw-********`	NAT 边界防火墙实例 ID。
NatFirewallName	String	否	`NatFirewallName`	NAT 边界防火墙实例名称。
NatGatewayId	String	否	`ngw-********`	NAT 网关 ID。
NatGatewayName	String	否	`NatGatewayName`	NAT 网关名称。
PageNumber	Integer	否	`1`	分页页码，默认值为 1。
PageSize	Integer	否	`10`	分页大小，默认值为 10。
RegionCode	Array of String	否	`cn-beijing`	实例所属地域。
VpcId	String	否	`vpc-********`	VPC ID。
VpcName	String	否	`VpcName`	VPC 名称。

返回参数

参数	类型	示例值	描述
Count	Integer	`10`	当前页面返回的 NAT 防火墙实例数量。
Data	Array of NatFirewallStructure	`--`	NAT 防火墙实例详情。
PageNumber	Integer	`1`	返回数据的分页页码。
PageSize	Integer	`10`	返回数据的分页大小。
TotalCount	Integer	`12`	返回的 NAT 防火墙实例总量。

NatFirewallStructure

参数	类型	示例值	描述
VpcId	String	`vpc-********`	VPC ID。
Region	String	`cn-beijing`	实例所属地域。
ZoneId	String	`cn-guilin-c`	实例可用区。
VpcCidr	String	`180...1/16`	VPC 网段。
VpcName	String	`VpcName`	VPC 名称。
AccountId	String	`2100052***`	账号 ID。
Bandwidth	Integer	`10`	授权流量带宽。
CanCreate	Boolean	`true`	是否支持创建 NAT 边界防火墙。 true：是 false：否
ErrMessage	String	`ErrMessage`	错误信息。
NatGatewayId	String	`ngw-********`	NAT 网关实例 ID。
NatFirewallId	String	`nfw-********`	NAT 边界防火墙实例 ID。
FirewallStatus	String	`opened`	NAT 边界防火墙实例状态。
NatGatewayName	String	`NatGatewayName`	NAT 网关实例名称。
NatFirewallName	String	`NatFirewallName`	NAT 边界防火墙实例名称。
PeakTrafficWithin7Day	Integer	`16998336`	该 NAT 边界防火墙实例近 7 天内的流量峰值。

请求示例

POST ?Action=DescribeNatFirewallList&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "FirewallStatus": [
        ""
    ],
    "NatFirewallId": "nfw-********",
    "NatFirewallName": "NatFirewallName",
    "NatGatewayId": "ngw-********",
    "NatGatewayName": "NatGatewayName",
    "PageNumber": 1,
    "PageSize": 10,
    "RegionCode": [
        ""
    ],
    "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
    }
}