获取NAT网关列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取NAT网关列表

最近更新时间：2024.12.31 16:28:28首次发布时间：2024.12.31 16:28:28

本接口用于获取 NAT 网关的列表。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com/?Action=ListNatGateways&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListNatGateways	公共参数。该参数表示接口名称。取值：ListNatGateways。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
cluster_name	String	否	****-xxct	节点名称。如需获取支持 NAT 网关的节点列表，请提交工单进行申请。
status_list	String	否	creating,updating	状态列表。状态之间用半角逗号（,）分隔。取值范围： creating：创建中。 running：运行中。 updating：更新中。 deleting：删除中。
fuzzy_id_or_name	String	否	bhhc****	NAT 网关的 ID 或名称。支持模糊查询。
page	Integer	否	1	NAT 网关列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页指定行数的数据；如果仅指定 page，不指定 limit，将返回指定页的数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	10	分页查询时设置的每页行数。默认值：10。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页指定行数的数据；如果仅指定 page，不指定 limit，将返回指定页的数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	1	查询出来的 NAT 网关的排列顺序。取值范围： 1（默认值）：按照降序排列。 2：按照增序排列。
order_by_field	String	否	create_at	查询出来的 NAT 网关的排序依据。取值范围： create_at（默认值）：按照创建时间排序。 update_at：按照更新时间排序。

返回参数

名称	类型	示例值	描述
natgw_list	[]NATGateway	请参见返回示例	NAT 网关列表。
total_count	Integer	2	NAT 网关的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListNatGateways&Version=2021-04-30
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412301804526F3EB2B6B660B83F****",
        "Action": "ListNatGateways",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "natgw_list": [
            {
                "account_identity": 210006****,
                "user_identity": 21000****,
                "natgw_identity": "natgw-5tdksw5c2k****",
                "natgw_name": "nat-dev01",
                "status": "running",
                "cluster": {
                    "cluster_name": "****-czcm",
                    "country": "CN",
                    "region": "EastChina",
                    "province": "JS",
                    "city": "320400",
                    "isp": "CMCC",
                    "level": "3",
                    "alias": "**移动"
                },
                "vpc": {
                    "vpc_identity": "vpc-jdkn6****",
                    "vpc_name": "**移动-默认VPC"
                },
                "eip_list": [
                    {
                        "eip_identity": "eip-vk26c****",
                        "eip_addr": "223.**.**.44"
                    }
                ],
                "bps_limit": "2000",
                "billing_method": "HourUsed",
                "connect_limit": "500000",
                "new_connect_limit": "50000",
                "project": "default",
                "is_overdue": false,
                "start_at": 1732197769,
                "create_time": 1732197768,
                "update_time": 1732197812
            }
        ],
        "total_count": 1
    }
}