NAT网关
NAT网关
文档指南
请输入
- 文档首页
NAT网关API参考NAT网关DescribeNatGateways - 查询NAT网关
复制全文
下载 pdfDescribeNatGateways - 查询NAT网关
文档反馈
问问助手调用 DescribeNatGateways 接口，查询满足指定条件的NAT网关实例。
使用说明
- 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的NAT网关，若没有符合条件的NAT网关，则返回空值。
- 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有NAT网关。
- 使用标签过滤NAT网关实例时，最多可查询指定标签关联的1000个NAT网关实例。如果指定标签关联的NAT网关实例超过1000个，则请您使用ListTagsForResources接口查询。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeNatGateways
要执行的操作，取值：DescribeNatGateways。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
Description string 可选 示例值：This is a nat
NAT网关的描述。
TagFilters.N.Values.N string[] 可选 示例值：v1
NAT网关标签的标签值（Value）。
- 第一个N：表示标签键的序号，取值范围：1～10。
- 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的NAT网关。
- 多个标签值之间用&分隔。
说明
- 若传入该参数，则必须先传入TagFilters.N.Key。
- 传入空字符串时，表示查询标签值为空的NAT网关。
TagFilters.N.Key string[] 可选 示例值：k1
NAT网关标签的标签键（Key）。
- 参数 - N：表示标签键的序号，取值范围：1～10。
- 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的NAT网关。
- 不允许重复。
NatGatewayName string 可选 示例值：nat-01
NAT网关的名称。
PageSize integer 可选 示例值：20
分页查询时每页的行数。取值范围：1～100，默认值：20。
PageNumber integer 可选 示例值：1
列表的页码，默认值为1。
Spec string 可选 示例值：Medium
NAT网关的规格。
- Small（默认）：小型。
- Medium：中型。
- Large：大型。
NetworkType string 可选 示例值：internet
NAT网关类型。取值如下：
- internet（默认）：公网NAT网关。
- intranet：私网NAT网关。
ProjectName string 可选 示例值：Project_1
NAT网关所属项目的名称。
NatGatewayIds.N string[] 可选 示例值：ngw-3tex2x1cwd4c6c0v****
NAT网关的ID。
- 参数 - N：表示NAT网关的序号，单次调用数量上限20个ID。
- 多个ID之间请使用&分隔。
返回参数
PageNumber integer 示例值：1
当前页码。
NatGateways object[] 示例值：-
NAT网关的详细信息。
NatGatewayName string 示例值：nat-01
NAT网关的名称。
Description string 示例值：This is a nat
NAT网关的描述信息。
EipAddresses object[]
NAT网关绑定公网IP的信息。
AllocationId string 示例值：eip-4v0x57pna7x****
公网IP的ID。
EipAddress string 示例值：121.XX.XX.52
公网IP的地址。
UsingStatus string 示例值：Idle
公网IP的使用状态。
- Idle：未使用。
- UsedBySnat：被SNAT规则使用。
- UsedByDnat：被DNAT规则使用。
- UsedByNat：被SNAT/DNAT规则同时使用。
VpcId string 示例值：vpc-yxa83n6nu****
NAT网关所属私有网络的ID。
Spec string 示例值：Medium
NAT网关的规格。
- Small（默认）：小型。
- Medium：中型。
- Large：大型。
BillingType integer 示例值：2
NAT网关的计费方式。
- 1 ：包年包月。
- 2：按量计费-按规格计费。
- 3：按量计费-按使用量计费。
NatGatewayId string 示例值：ngw-3tex2x1cwd4c6c0v****
NAT网关的ID。
ExpiredTime string 示例值：2021-05-07 23:59:59
包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
DeletedTime string 示例值：2021-12-21 18:26:27
预期资源强制回收时间。
- 包年包月NAT网关，此参数有返回值。
- 按量计费NAT网关，仅欠费冻结时，此参数有返回值。
OverdueTime string 示例值：2021-12-06 18:26:27
资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
UpdatedAt string 示例值：2021-12-06T18:26:27+08:00
NAT网关的最近操作时间。
CreationTime string 示例值：2021-11-30T16:59:27+08:00
NAT网关创建的时间。
BusinessStatus string 示例值：Normal
NAT网关是否被锁定。
- 空值：正常未被锁定。
- Normal：正常未被锁定。
- FinancialLocked：因欠费被锁定。
Status string 示例值：Available
NAT网关的状态。
- Available：可用。
- Creating：创建中。
- Pending：操作中。
- Deleting：删除中。
Tags object[]
NAT网关的标签信息。
Key string 示例值：k1
标签键。
Value string 示例值：v1
标签值。
ProjectName string 示例值：Project_1
NAT网关所属项目的名称。
NetworkInterfaceId string 示例值：eni-13fvhq3a7opv****
NAT网关占用网卡的ID。
ZoneId string 示例值：cn-beijing-a
NAT网关所属主可用区的ID。
SubnetId string 示例值：subnet-kty2akgv0x5****
NAT网关所属子网的ID。
LockReason string 示例值：financial
NAT被锁定的原因。
- financial：因欠费被锁定。
- security：因安全原因被锁定。
SnatEntryIds string[] 示例值：["snat-3fvhk47kf56****", "snat-3fvhk47kf78****"]
SNAT规则ID列表。
NetworkType string 示例值：internet
NAT网关类型。
- internet：公网NAT网关。
- intranet：私网NAT网关。
DnatEntryIds string[] 示例值：["dnat-342abc3bc3****", "dnat-342abc3bd4****"]
DNAT规则ID列表。
SmartScheduleEnabled boolean 示例值：false
是否开启智能调度
SmartScheduleRule string 示例值：ChinaMobile,ChinaTelecom,ChinaUnicom,BGP
智能调度策略
DirectMode boolean
直通、非直通
PageSize integer 示例值：20
当前分页的行数。
RequestId string 示例值：2021062415303301022514515207C4****
请求ID。
TotalCount integer 示例值：33
符合条件的NAT网关数量。
请求示例
GET /?Action=DescribeNatGateways&Version=2020-04-01&NatGatewayIds.1=ngw-2fesmko5zhdz459gp67sc****&PageNumber=1&PageSize=5 HTTP/1.1
Host: natgateway.cn-beijing.volcengineapi.com
Service: natgateway
Region: cn-beijing
返回示例
{
"ResponseMetadata": {
"RequestId": "2021062415303301022514515207C4****",
"Action": "DescribeNatGateways",
"Version": "2020-04-01",
"Service": "natgateway",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "2021062415303301022514515207C4****",
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 5,
"NatGateways": [
{
"NetworkType": "internet",
"NatGatewayId": "ngw-2feq5xhimd88w59gp686****",
"NatGatewayName": "nat-01",
"Description": "This is a nat",
"Spec": "Small",
"BillingType": 2,
"EipAddresses": [
{
"AllocationId": "eip-2fejrf9qxlla859gp6850****",
"EipAddress": "180.XX.XX.79",
"UsingStatus": "UsedBySnat"
}
],
"DirectMode":false,
"BandwidthLimit":10,
"VpcId": "vpc-2feacqu7h3klc59gp67u3****",
"SubnetId": "subnet-2feacrhvug8ao59gp671b****",
"ZoneId": "cn-beijing-a",
"NetworkInterfaceId": "eni-2fesmkw23xlvk59gp67g9****",
"SnatEntryIds"[
"snat-3fvhk47kf56****",
"snat-3fvhk47kf78****"
],
"DnatEntryIds"[
"dnat-342abc3bc3****",
"dnat-342abc3bd4****"
],
"ProjectName": "Project_1",
"Tags":[
{
"Key":"k1",
"Value":"v1"
},
{
"Key":"k2",
"Value":""
}
]
"Status": "Available",
"BusinessStatus": "FinancialLocked",
"LockReason": "financial",
"CreationTime": "2021-11-30T16:59:27+08:00",
"UpdatedAt": "2021-12-06T18:26:27+08:00",
"ExpiredTime": "",
"OverdueTime": "2021-12-06 18:26:27",
"DeletedTime": "2021-12-21 18:26:27"
}
]
}
}
错误码
最近更新时间：2025.12.23 18:56:15
这个页面对您有帮助吗？
有用
有用
无用
无用