文档

DescribeForwardTableEntries - 查询已创建的DNAT条目

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

NAT 网关所在的地域 ID。

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

cn-hangzhou
ForwardTableIdstring

DNAT 列表的 ID。

说明 ForwardTableIdNatGatewayId 参数至少输入一个。
ftb-bp1mbjubq34hlcqpa****
ForwardEntryIdstring

DNAT 条目 ID。

fwd-8vbn3bc8roygjp0gy****
ExternalIpstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该参数为 DNAT 条目中提供公网访问的弹性公网 IP 地址。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该参数为供外部网络访问的 NAT IP 地址。

116.28.XX.XX
ExternalPortstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该参数为进行端口转发的外部端口或端口段。

    • 查询的端口范围需要在 1~65535 之间。
    • 如果需要查询的是端口段,请在输入时以正斜线(/)隔开起始端口,例如10/20
    • 如果查询的 ExternalPort 为端口段,查询的 InternalPort 也需要设置为端口段,且端口段的端口个数相同,例如 ExternalPort 设置为10/20InternalPort 设置为80/90
  • 当查询 VPC NAT 网关的 DNAT 条目时,该参数为 NAT IP 地址被外部网络访问的端口,取值范围:1~65535

8080
InternalIpstring

私网 IP 地址。

  • 当查询公网 NAT 网关的 DNAT 条目时,该参数为通过 DNAT 条目进行公网通信的 ECS 实例的私网 IP 地址。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该参数为需要通过 DNAT 规则进行通信的私网 IP 地址。

192.168.XX.XX
InternalPortstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该参数为进行端口转发的内部端口或端口段,取值范围:1~65535

  • 当查询 VPC NAT 网关的 DNAT 条目时,该参数为需要映射的目标 ECS 实例端口,取值范围:1~65535

80
IpProtocolstring

协议类型,取值:

  • tcp:转发 TCP 协议的报文。

  • udp:转发 UDP 协议的报文。

  • any:转发所有协议的报文。

tcp
ForwardEntryNamestring

DNAT 条目的名称。

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

ForwardEntry-1
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10
NatGatewayIdstring

要查询的 NAT 网关的 ID。

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

返回参数

名称类型描述示例值
object
PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

A6C4A8B1-7561-4509-949C-20DEB40D71E6
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目数。

5
ForwardTableEntriesobject []

查询的 DNAT 列表详细信息。

Statusstring

DNAT 条目的状态,取值:

  • Pending:配置中,可能是创建中或修改中。

  • Available:可用。

  • Deleting:删除中。

Available
ForwardEntryIdstring

DNAT 条目的 ID。

fwd-119smw5tk****
InternalIpstring

私网 IP 地址。

  • 当查询公网 NAT 网关的 DNAT 条目时,该返回参数为通过 DNAT 条目进行公网通信的 ECS 实例的私网 IP 地址。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该返回参数为需要通过 DNAT 规则进行通信的私网 IP 地址。

192.168.XX.XX
InternalPortstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该参数为进行端口转发的内部端口或端口段。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该参数为需要映射的目标 ECS 实例端口。

25
ForwardEntryNamestring

DNAT 条目的名称。

ForwardEntry-1
ForwardTableIdstring

DNAT 条目所属 DNAT 表的 ID。

ftb-11tc6xgmv****
IpProtocolstring

协议类型,取值:

  • tcp:转发 TCP 协议的报文。

  • udp:转发 UDP 协议的报文。

  • any:转发所有协议的报文。

tcp
ExternalPortstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该返回参数为进行端口转发的外部端口或端口段。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该返回参数为 NAT IP 地址被外部网络访问的端口。

80
ExternalIpstring
  • 当查询公网 NAT 网关的 DNAT 条目时,该返回参数为 DNAT 条目中提供公网访问的公网 IP 地址。

  • 当查询 VPC NAT 网关的 DNAT 条目时,该返回参数为供外部网络访问的 NAT IP 地址。

139.79.XX.XX
NatGatewayIdstring

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错误码错误信息描述
400IncorretForwardEntryStatusSome Forward entry status blocked this operation..无法执行该操作。DNAT表中有DNAT条目的状态处于Pending或Modifying状态。
400DESCRIBE_FORWARD_PARAM_INVALIDForwardTableId and natGatewayId can not both be null-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
404InvalidForwardTableId.NotFoundSpecified forwardTableId does not exist指定的 DNAT 表不存在,请您检查输入参数是否正确。

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

变更历史

变更时间变更内容概要操作
2023-08-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)