调用DescribeForwardTableEntries查询已创建的DNAT条目_专有网络VPC(VPC)-阿里云帮助中心

调用DescribeForwardTableEntries接口查询已创建的DNAT条目。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeForwardTableEntries	get	*ForwardTable `acs:vpc:{#regionId}:{#accountId}:forwardtable/{#ForwardTableId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	NAT 网关所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
ForwardTableId	string	否	DNAT 列表的 ID。说明 ForwardTableId 和 NatGatewayId 参数至少输入一个。	ftb-bp1mbjubq34hlcqpa****
ForwardEntryId	string	否	DNAT 条目 ID。	fwd-8vbn3bc8roygjp0gy****
ExternalIp	string	否	当查询公网 NAT 网关的 DNAT 条目时，该参数为 DNAT 条目中提供公网访问的弹性公网 IP 地址。当查询 VPC NAT 网关的 DNAT 条目时，该参数为供外部网络访问的 NAT IP 地址。	116.28.XX.XX
ExternalPort	string	否	当查询公网 NAT 网关的 DNAT 条目时，该参数为进行端口转发的外部端口或端口段。查询的端口范围需要在 1~65535 之间。如果需要查询的是端口段，请在输入时以正斜线（/）隔开起始端口，例如`10/20`。如果查询的 ExternalPort 为端口段，查询的 InternalPort 也需要设置为端口段，且端口段的端口个数相同，例如 ExternalPort 设置为`10/20`，InternalPort 设置为`80/90`。当查询 VPC NAT 网关的 DNAT 条目时，该参数为 NAT IP 地址被外部网络访问的端口，取值范围：1~65535。	8080
InternalIp	string	否	私网 IP 地址。当查询公网 NAT 网关的 DNAT 条目时，该参数为通过 DNAT 条目进行公网通信的 ECS 实例的私网 IP 地址。当查询 VPC NAT 网关的 DNAT 条目时，该参数为需要通过 DNAT 规则进行通信的私网 IP 地址。	192.168.XX.XX
InternalPort	string	否	当查询公网 NAT 网关的 DNAT 条目时，该参数为进行端口转发的内部端口或端口段，取值范围：1~65535。当查询 VPC NAT 网关的 DNAT 条目时，该参数为需要映射的目标 ECS 实例端口，取值范围：1~65535。	80
IpProtocol	string	否	协议类型，取值： tcp：转发 TCP 协议的报文。 udp：转发 UDP 协议的报文。 any：转发所有协议的报文。	tcp
ForwardEntryName	string	否	DNAT 条目的名称。名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。	ForwardEntry-1
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的行数。最大值：50。默认值：10。	10
NatGatewayId	string	否	要查询的 NAT 网关的 ID。说明 ForwardTableId 和 NatGatewayId 参数至少输入一个。	ngw-bp1uewa15k4iy5770****

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	A6C4A8B1-7561-4509-949C-20DEB40D71E6
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目数。	5
ForwardTableEntries	array<object>	查询的 DNAT 列表详细信息。
ForwardTableEntry	object	查询的 DNAT 列表详细信息。
Status	string	DNAT 条目的状态，取值： Pending：配置中，可能是创建中或修改中。 Available：可用。 Deleting：删除中。	Available
ForwardEntryId	string	DNAT 条目的 ID。	fwd-119smw5tk****
InternalIp	string	私网 IP 地址。当查询公网 NAT 网关的 DNAT 条目时，该返回参数为通过 DNAT 条目进行公网通信的 ECS 实例的私网 IP 地址。当查询 VPC NAT 网关的 DNAT 条目时，该返回参数为需要通过 DNAT 规则进行通信的私网 IP 地址。	192.168.XX.XX
InternalPort	string	当查询公网 NAT 网关的 DNAT 条目时，该参数为进行端口转发的内部端口或端口段。当查询 VPC NAT 网关的 DNAT 条目时，该参数为需要映射的目标 ECS 实例端口。	25
ForwardEntryName	string	DNAT 条目的名称。	ForwardEntry-1
ForwardTableId	string	DNAT 条目所属 DNAT 表的 ID。	ftb-11tc6xgmv****
IpProtocol	string	协议类型，取值： tcp：转发 TCP 协议的报文。 udp：转发 UDP 协议的报文。 any：转发所有协议的报文。	tcp
ExternalPort	string	当查询公网 NAT 网关的 DNAT 条目时，该返回参数为进行端口转发的外部端口或端口段。当查询 VPC NAT 网关的 DNAT 条目时，该返回参数为 NAT IP 地址被外部网络访问的端口。	80
ExternalIp	string	当查询公网 NAT 网关的 DNAT 条目时，该返回参数为 DNAT 条目中提供公网访问的公网 IP 地址。当查询 VPC NAT 网关的 DNAT 条目时，该返回参数为供外部网络访问的 NAT IP 地址。	139.79.XX.XX
NatGatewayId	string	DNAT 条目所属的 NAT 网关的 ID。	ngw-bp1uewa15k4iy5770****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "A6C4A8B1-7561-4509-949C-20DEB40D71E6",
  "PageNumber": 1,
  "TotalCount": 5,
  "ForwardTableEntries": {
    "ForwardTableEntry": [
      {
        "Status": "Available",
        "ForwardEntryId": "fwd-119smw5tk****",
        "InternalIp": "192.168.XX.XX",
        "InternalPort": "25",
        "ForwardEntryName": "ForwardEntry-1",
        "ForwardTableId": "ftb-11tc6xgmv****",
        "IpProtocol": "tcp",
        "ExternalPort": "80",
        "ExternalIp": "139.79.XX.XX",
        "NatGatewayId": "ngw-bp1uewa15k4iy5770****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorretForwardEntryStatus	Some Forward entry status blocked this operation..	无法执行该操作。DNAT表中有DNAT条目的状态处于Pending或Modifying状态。
400	DESCRIBE_FORWARD_PARAM_INVALID	ForwardTableId and natGatewayId can not both be null	-
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。
404	InvalidForwardTableId.NotFound	Specified forwardTableId does not exist	指定的 DNAT 表不存在，请您检查输入参数是否正确。

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

变更历史

变更时间	变更内容概要	操作
2023-08-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-01	OpenAPI 错误码发生变更	查看变更详情