全部产品
Search
文档中心

NAT 网关:ListFullNatEntries - 查询FULLNAT条目的列表信息

更新时间:Nov 14, 2024

调用ListFullNatEntries接口查询FULLNAT条目的列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ListFullNatEntriesget
  • FullNat
    acs:vpc:{#regionId}:{#accountId}:vpcfullnattable/{#FullNatTableId}

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
FullNatTableIdstring

要查询的 FULLNAT 条目所属的 FULLNAT 表 ID。

说明 FullNatTableIdNatGatewayId 参数至少输入一个。
fulltb-gw88z7hhlv43rmb26****
FullNatEntryIdstring

要查询的 FULLNAT 条目 ID。

fullnat-gw8fz23jezpbblf1j****
FullNatEntryNamesarray

要查询的 FULLNAT 条目的名称。最多支持查询 20 个 FULLNAT 条目的名称。

名称长度在 2~128 个字符之间,以英文字母或中文开头,可包含数字、短划线(-)和下划线(_)。

string

要查询的 FULLNAT 条目的名称。最多支持输入 20 个 FULLNAT 条目的名称。

名称长度在 2~128 个字符之间,以英文字母或中文开头,可包含数字、短划线(-)和下划线(_)。

test
NetworkInterfaceIdsarray

要查询的弹性网卡 ID。

string

要查询的弹性网卡 ID。最多支持输入 20 个弹性网卡 ID。

eni-gw80wedm8pq0tpr2****
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
caeba0bbb2be03f84eb48b699f0a4883
MaxResultslong

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
RegionIdstring

要查询 FULLNAT 条目所属 VPC NAT 网关的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

eu-central-1
IpProtocolstring

转发端口的协议类型,取值:

  • TCP:转发 TCP 协议的报文。
  • UDP:转发 UDP 协议的报文。
TCP
NatGatewayIdstring

要查询的 NAT 网关的 ID。

说明 FullNatTableIdNatGatewayId 参数至少输入一个。
ngw-bp1uewa15k4iy5770****
NatIpstring

要查询的 FULLNAT 条目的 NAT IP 地址。

10.0.XX.XX
NatIpPortstring

要查询的 FULLNAT 条目的前端端口值,取值范围:1~65535。

443

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

F03E41F6-1A74-311F-8D98-124EEE9F37B8
NatGatewayIdstring

VPC NAT 网关的实例 ID。

ngw-gw8054kn57y3hq3bv****
FullNatTableIdstring

查询的 FULLNAT 条目所属的 FULLNAT 表的 ID。

fullnat-gw8fz23jezpbblf1j****
TotalCountlong

查询的 FULLNAT 条目的结果个数。

1
NextTokenstring

是否拥有下一个查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一个查询开始的令牌。
caeba0bbb2be03f84eb48b699f0a4883
MaxResultslong

查询的最大结果个数。

1
FullNatEntriesarray<object>

查询的 FULLNAT 条目的列表信息。

FullNatEntryobject

查询的 FULLNAT 条目的列表信息。

NatIpstring

FULLNAT 条目中提供地址转换的 NAT IP 地址。

192.168.XX.XX
NatIpPortstring

FULLNAT 条目中进行端口映射的前端端口,取值范围:1~65535

80
AccessIpstring

FULLNAT 条目中进行 FULLNAT 地址转换的后端 IP 地址。

192.168.XX.XX
AccessPortstring

FULLNAT 条目中进行端口映射的后端端口,取值范围:1~65535

80
IpProtocolstring

转发协议类型,取值:

  • TCP:转发 TCP 协议的报文。
  • UDP:转发 UDP 协议的报文。
TCP
NetworkInterfaceIdstring

弹性网卡 ID。

eni-gw80wedm8pq0tpr2****
NetworkInterfaceTypestring

弹性网卡的类型,目前仅取值为 Endpoint(反向终端节点)。

Endpoint
FullNatEntryNamestring

FULLNAT 条目的名称。

名称长度在 2~128 个字符之间,以英文字母或中文开头,可包含数字、短划线(-)和下划线(_)。

test
FullNatEntryDescriptionstring

FULLNAT 条目的描述信息。

长度为 2~128 个字符,必须以大小写字母或中文开头,但不能以http://https://开头。

abc
CreationTimestring

FULLNAT 条目的创建时间。

2021-10-27T02:44:40Z
FullNatEntryIdstring

FULLNAT 条目的 ID。

fullnat-gw8fz23jezpbblf1j****
FullNatEntryStatusstring

FULLNAT 条目的状态,取值:

  • Pending:配置中。
  • Available:可用。
  • Deleting:删除中。
  • Deleted:已删除。
Available
FullNatTableIdstring

FullNAT 条目所属的 FullNAT 列表的 ID。

fulltb-gw88z7hhlv43rmb26****

示例

正常返回示例

JSON格式

{
  "RequestId": "F03E41F6-1A74-311F-8D98-124EEE9F37B8",
  "NatGatewayId": "ngw-gw8054kn57y3hq3bv****",
  "FullNatTableId": "fullnat-gw8fz23jezpbblf1j****",
  "TotalCount": 1,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "MaxResults": 1,
  "FullNatEntries": [
    {
      "NatIp": "192.168.XX.XX",
      "NatIpPort": "80",
      "AccessIp": "192.168.XX.XX",
      "AccessPort": "80",
      "IpProtocol": "TCP",
      "NetworkInterfaceId": "eni-gw80wedm8pq0tpr2****",
      "NetworkInterfaceType": "Endpoint",
      "FullNatEntryName": "test",
      "FullNatEntryDescription": "abc",
      "CreationTime": "2021-10-27T02:44:40Z",
      "FullNatEntryId": "fullnat-gw8fz23jezpbblf1j****",
      "FullNatEntryStatus": "Available",
      "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.FullNatTableIdThe specified resource of %s is not found.FullNat表不存在
400MissingParam.FullnatTableIdOrNatGatewayIdFullnatTableId and natGatewayId can not both be nullFullnatTableId和natGatewayId不能同时为空
400ResourceNotFound.FullNatTableThe NAT gateway has no full nat table.NAT网关没有full nat 表。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情