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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeForwardTableEntries

系统规定参数。取值:DescribeForwardTableEntries

RegionId String cn-hangzhou

NAT网关所在的地域ID。

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

ForwardTableId String ftb-bp1mbjubq34hlcqpa****

DNAT列表的ID。

ForwardEntryId String fwd-8vbn3bc8roygjp0gy****

DNAT条目ID。

ExternalIp String 116.28.XX.XX
  • 当查询公网NAT网关的DNAT条目时,该参数为DNAT条目中提供公网访问的弹性公网IP地址。
  • 当查询VPC NAT网关的DNAT条目时,该参数为供外部网络访问的NAT IP地址。
ExternalPort String 8080
  • 当查询公网NAT网关的DNAT条目时,该参数为进行端口转发的外部端口或端口段。
    • 查询的端口范围需要在1~65535之间。
    • 如果需要查询的是端口段,请在输入时以正斜线(/)隔开起始端口,例如10/20
    • 如果查询的ExternalPort为端口段,查询的InternalPort也需要设置为端口段,且端口段的端口个数相同,例如ExternalPort设置为10/20InternalPor设置为80/90
  • 当查询VPC NAT网关的DNAT条目时,该参数为NAT IP地址被外部网络访问的端口,取值范围:1~65535
InternalIp String 192.168.XX.XX
  • 当查询公网NAT网关的DNAT条目时,该参数为通过DNAT条目进行公网通信的ECS实例的私网IP地址。
  • 当查询VPC NAT网关的DNAT条目时,该参数为需要通过DNAT规则进行通信的私网IP地址。
InternalPort String 80
  • 当查询公网NAT网关的DNAT条目时,该参数为进行端口转发的内部端口或端口段,取值范围:1~65535
  • 当查询VPC NAT网关的DNAT条目时,该参数为需要映射的目标ECS实例端口,取值范围:1~65535
IpProtocol String TCP

协议类型,取值:

  • TCP:转发TCP协议的报文。
  • UDP:转发UDP协议的报文。
  • Any:转发所有协议的报文。
ForwardEntryName String ForwardEntry-1

DNAT条目的名称。

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

PageNumber Integer 1

列表的页码。默认值:1

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页包含的条目数。

RequestId String A6C4A8B1-7561-4509-949C-20DEB40D71E6

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 5

列表条目数。

ForwardTableEntries Array of ForwardTableEntry

查询的DNAT列表详细信息。

ForwardTableEntry
Status String Available

DNAT条目的状态,取值:

  • Pending:配置中,可能是创建中或修改中。
  • Available:可用。
  • Deleting:删除中。
ForwardEntryId String fwd-119smw5tk****

DNAT条目的ID。

InternalIp String 192.168.XX.XX
  • 当查询公网NAT网关的DNAT条目时,该返回参数为通过DNAT条目进行公网通信的ECS实例的私网IP地址。
  • 当查询VPC NAT网关的DNAT条目时,该返回参数为需要通过DNAT规则进行通信的私网IP地址。
InternalPort String 25
  • 当查询公网NAT网关的DNAT条目时,该参数为进行端口转发的内部端口或端口段。
  • 当查询VPC NAT网关的DNAT条目时,该参数为需要映射的目标ECS实例端口。
ForwardEntryName String ForwardEntry-1

DNAT条目的名称。

ForwardTableId String ftb-11tc6xgmv****

DNAT条目所属DNAT表的ID。

IpProtocol String TCP

协议类型,取值:

  • TCP:转发TCP协议的报文。
  • UDP:转发UDP协议的报文。
  • Any:转发所有协议的报文。
ExternalPort String 80
  • 当查询公网NAT网关的DNAT条目时,该返回参数为进行端口转发的外部端口或端口段。
  • 当查询VPC NAT网关的DNAT条目时,该返回参数为NAT IP地址被外部网络访问的端口。
ExternalIp String 139.79.XX.XX
  • 当查询公网NAT网关的DNAT条目时,该返回参数为DNAT条目中提供公网访问的公网IP地址。
  • 当查询VPC NAT网关的DNAT条目时,该返回参数为供外部网络访问的NAT IP地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeForwardTableEntries
&ResourceOwnerId=11
&RegionId=cn-hangzhou
&ForwardTableId=ftb-bp1mbjubq34hlcqpa****
&ForwardEntryId=fwd-8vbn3bc8roygjp0gy****
&ExternalIp=116.28.XX.XX
&ExternalPort=8080
&InternalIp=192.168.XX.XX	
&InternalPort=80
&IpProtocol=TCP
&ForwardEntryName=ForwardEntry-1
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeForwardTableEntriesResponse>
    <PageSize>10</PageSize>
    <RequestId>A6C4A8B1-7561-4509-949C-20DEB40D71E6</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>5</TotalCount>
    <ForwardTableEntries>
        <Status>Available</Status>
        <ForwardEntryId>fwd-119smw5tk****</ForwardEntryId>
        <InternalIp>192.168.XX.XX</InternalIp>
        <InternalPort>25</InternalPort>
        <ForwardEntryName>ForwardEntry-1</ForwardEntryName>
        <ForwardTableId>ftb-11tc6xgmv****</ForwardTableId>
        <IpProtocol>TCP</IpProtocol>
        <ExternalPort>80</ExternalPort>
        <ExternalIp>139.79.XX.XX</ExternalIp>
    </ForwardTableEntries>
</DescribeForwardTableEntriesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "A6C4A8B1-7561-4509-949C-20DEB40D71E6",
  "PageNumber" : 1,
  "TotalCount" : 5,
  "ForwardTableEntries" : [ {
    "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"
  } ]
}

错误码

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

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