调用 DescribeNatGateways 接口，查询满足指定条件的NAT网关实例。 ## 调用说明 * 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的NAT网关，若没有符合条件的NAT网关，则返回空值。 * 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有NAT网关。 * 使用标签过滤NAT网关实例时，最多可查询指定标签关联的1000个NAT网关实例。如果指定标签关联的NAT网关实例超过1000个，则请您使用 [ListTagsForResources](https://www.volcengine.com/docs/6401/129394) 接口查询。 ## 调试 ## 请求参数 |参数名称 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |DescribeNatGateways |要执行的操作，取值：DescribeNatGateways。 | |Version |String |是 |2020\-04\-01 |API的版本信息，当前版本为：2020\-04\-01。 | |NetworkType |String |否 |internet |NAT网关类型。取值如下：|\ | | | | ||\ | | | | |* internet：公网NAT网关。|\ | | | | |* intranet：私网NAT网关。 | |NatGatewayIds .N |String |否 |NatGatewayIds.1= ngw\-3tex2x1cwd4c6c0v\*\*\*\*&NatGatewayIds.2= ngw\-4te0x5cdw4t2c1a\*\*\*\* |NAT网关的ID。|\ | | | | |参数 \- N：表示NAT网关的序号，单次调用数量上限20个ID。|\ | | | | |多个ID之间请使用&分隔。 | |NatGatewayName |String |否 |nat\-01 |NAT网关的名称。 | |Description |String |否 |This is a nat |NAT网关的描述。 | |Spec |String |否 |Medium |NAT网关的规格。取值如下：|\ | | | | |Small：小型。|\ | | | | |Medium：中型。|\ | | | | |Large：大型。 | |VpcId |String |否 |vpc\-p1b1p30ve5yze\*\*\*\* |NAT网关所在私有网络的ID。|\ | | | | |您可以调用 [DescribeVpcs](https://www.volcengine.com/docs/6401/70495) 接口，查询VPC的ID。 | |SubnetId |String |否 |subnet\-1t1apofp97\*\*\*\* |NAT网关所在子网的ID。|\ | | | | |您可以调用 [DescribeSubnets](https://www.volcengine.com/docs/6401/70497) 接口，查询子网的ID。 | |ProjectName |String |否 |Project_1 |NAT网关所属项目的名称。 | |TagFilters.N.Key |String |否 |TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3 |标签的标签键。|\ | | | | ||\ | | | | |* 参数 \- N：表示标签键的序号，取值范围：1～10。|\ | | | | |* 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的NAT网关。|\ | | | | |* 不允许重复。 | |TagFilters.N.Values.N |String |否 |TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1 |标签的标签值。|\ | | | | ||\ | | | | |* 第一个N：表示标签键的序号，取值范围：1～10。|\ | | | | |* 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的NAT网关。|\ | | | | |* 多个标签值之间用&分隔。|\ | | | | ||\ | | | | |:::tip|\ | | | | ||\ | | | | |* 若传入该参数，则必须先传入`TagFilters.N.Key`。|\ | | | | |* 传入空字符串时，表示查询标签值为空的NAT网关。|\ | | | | ||\ | | | | |:::| |PageSize |Integer |否 |20 |分页查询时每页的行数。取值范围：1～100，默认值：20。 | |PageNumber |Integer |否 |1 |列表的页码，默认值为1。 | ## 返回数据 |参数名称 |类型 |示例值 |描述 | |---|---|---|---| |RequestId |String |2021062415303301022514515207C4\*\*\*\* |请求ID。 | |TotalCount |Integer |33 |符合条件的NAT网关数量。 | |PageNumber |Integer |1 |当前页码。 | |PageSize |Integer |20 |当前分页的行数。 | |NatGateways |Array of struct |\- |NAT网关的详细信息。具体请参见下表“ **NatGateways结构** ”。 | **NatGateways结构** |参数名称 |类型 |示例值 |描述 | |---|---|---|---| |NetworkType |String |internet |NAT网关类型。|\ | | | ||\ | | | |* internet：公网NAT网关。|\ | | | |* intranet：私网NAT网关。 | |NatGatewayId |String |ngw\-3tex2x1cwd4c6c0v\*\*\*\* |NAT网关的ID。 | |NatGatewayName |String |nat\-01 |NAT网关的名称。 | |Description |String |This is a nat |NAT网关的描述信息。 | |Spec |String |Medium |NAT网关的规格。 | |BillingType |Integer |2 |NAT网关计费方式。|\ | | | ||\ | | | |* 1：包年包月。|\ | | | |* 2：按量计费\-按规格计费。|\ | | | |* 3：按量计费\-按使用量计费。 | |EipAddresses |Array of struct |\- |NAT网关绑定公网IP的信息。具体请参见下表“ **EipAddresses结构** ”。 | |VpcId |String |vpc\-yxa83n6nu\*\*\*\* |NAT网关所属私有网络的ID。 | |SubnetId |String |subnet\-kty2akgv0x5\*\*\*\* |NAT网关所属子网的ID。 | |ZoneId |string |cn\-beijing\-a |NAT网关所属主可用区的ID。 | |NetworkInterfaceId |String |eni\-13fvhq3a7opv\*\*\*\* |NAT网关占用网卡的ID。 | |SnatEntryIds |Array |["snat\-3fvhk47kf56\*\*\*\*", "snat\-3fvhk47kf78\*\*\*\*"] |SNAT规则ID列表。 | |DnatEntryIds |Array |["dnat\-342abc3bc3\*\*\*\*", "dnat\-342abc3bd4\*\*\*\*"] |DNAT规则ID列表。 | |ProjectName |String |Project_1 |NAT网关所属项目的名称。 | |Tags |Array of struct |\- |NAT网关的标签信息。具体请参见下表“**Tags结构**”。 | |Status |String |Available |NAT网关的状态。|\ | | | |Available：可用。|\ | | | |Creating：创建中。|\ | | | |Pending：操作中。|\ | | | |Deleting：删除中。 | |BusinessStatus |String |Normal |NAT网关是否被锁定。|\ | | | |空值：正常未被锁定。|\ | | | |Normal：正常未被锁定。|\ | | | |FinancialLocked：因欠费被锁定。 | |LockReason |String |financial |NAT被锁定的原因。|\ | | | |financial：因欠费被锁定。|\ | | | |security：因安全原因被锁定。 | |CreationTime |String |2021\-11\-30T16:59:27+08:00 |NAT网关创建的时间。 | |UpdatedAt |String |2021\-12\-06T18:26:27+08:00 |NAT网关的最近操作时间。 | |ExpiredTime |String |2021\-05\-07 23:59:59 |包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。 | |OverdueTime |String |2021\-12\-06 18:26:27 |资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。 | |DeletedTime |String |2021\-12\-21 18:26:27 |预期资源强制回收时间。|\ | | | ||\ | | | |* 包年包月NAT网关，此参数有返回值。|\ | | | |* 按量计费NAT网关，仅欠费冻结时，此参数有返回值。 | **EipAddresses结构** |参数名称 |类型 |示例值 |描述 | |---|---|---|---| |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规则同时使用。 | **Tags结构** |参数名称 |类型 |示例值 |描述 | |---|---|---|---| |Key |String |k1 |标签键。 | |Value |String |v1 |标签值。 | ## 请求示例 ```Plain Text GET /?Action=DescribeNatGateways&Version=2020-04-01&Spec=Medium&PageNumber=1&PageSize=5 HTTP/1.1 Host: open.volcengineapi.com Service: natgateway Region: cn-beijing ``` ## 返回示例 ```Plain Text { "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" } ], "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" } ] } } ``` ## 错误码公共错误码，请参见 [公共错误码](https://www.volcengine.com/docs/6404/76490) 。 |HttpCode |错误码 |错误信息 |描述 | |---|---|---|---| |400 |InvalidPage.Malformed |The specified page is malformed. |指定的分页参数不合法。 | |400 |InvalidTagFilter.Disorder |The specified index order of tag filter is malformed. |指定标签过滤项的索引顺序参数格式不合法。 | |400 |InvalidTagFilterKey.Malformed |The specified parameter tag filter key is invalid. |过滤标签键不合法。 | |400 |InvalidTagFilterValue.Malformed |The specified parameter tag filter value is invalid. |过滤标签值不合法。 | |400 |LimitExceeded.NatGatewayId |You've reached the limit on the number of NAT gateway IDs that you can describe. |已达到可查询的NAT网关ID数量上限。 | |400 |LimitExceeded.TagFilterKey |You've reached the limit on the number of tag keys that you can filter. |已达到单次可指定过滤标签键数量的上限。 | |400 |LimitExceeded.TagFilterValue |You've reached the limit on the number of tag values that you can filter. |已达到单次可指定过滤标签值数量的上限。 |