文档

DescribeForwardTableEntries - 查询DNAT条目

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

调试

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

授权信息

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

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

请求参数

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

NAT 网关的 ID。

nat-5t7nh1cfm6kxiszlttr38****
ForwardEntryIdstring

DNAT 条目 ID。

fwd-5tfi6f0rutmd00xrhkag7****
ExternalIpstring

DNAT 条目中提供公网访问的弹性公网 IP 地址。

36.XXX.XXX.72
InternalIpstring

通过 DNAT 条目进行公网通信的实例的私网 IP 地址。

10.XXX.XXX.50
ForwardEntryNamestring

DNAT 条目的名称。

test0
IpProtocolstring

协议类型,取值:

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

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

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

TCP
PageNumberinteger

查询列表的页码。起始值为 1

默认值:1

1
PageSizeinteger

分页查询时设置的每页行数,最大值为 100 行。

默认值:10

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberstring

当前查询页码。

1
TotalCountstring

列表条目数。

100
PageSizestring

分页查询时每页的行数。

10
ForwardTableEntriesobject []

查询的 DNAT 列表详细信息。

NatGatewayIdstring

NAT 网关的 ID。

nat-5tawjw5j7sgd2deujxuk0****
ForwardEntryIdstring

DNAT 条目的 ID。

fwd-5tf66679oi2uoxcvlg0g2****
ExternalIpstring

DNAT 条目中提供公网访问的弹性公网 IP 地址。

120.XXX.XXX.70
ExternalPortstring

进行端口转发的外部端口或端口段。

22
InternalIpstring

通过 DNAT 条目进行公网通信的实例的私网 IP 地址。

10.XXX.XXX.3
InternalPortstring

进行端口转发的内部端口或端口段。

22
ForwardEntryNamestring

DNAT 条目的名称。

test0
Statusstring

DNAT 条目状态,取值:

  • Pending:配置中,可能是创建中或修改中。
  • Available:可用。
  • Deleting:删除中。
Available
IpProtocolstring

协议类型,取值:

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

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

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

Any
HealthCheckPortstring

DNAT 探测端口。

80
StandbyExternalIpstring

提供公网访问的备用弹性公网 IP 地址。

101.XXX.XXX.7
StandbyStatusstring

备用弹性公网 IP 的状态

  • Running:开启
  • Stopping:关闭中
  • Stopped:关闭
  • Starting:启动中
Stopped

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": "1",
  "TotalCount": "100",
  "PageSize": "10",
  "ForwardTableEntries": [
    {
      "NatGatewayId": "nat-5tawjw5j7sgd2deujxuk0****",
      "ForwardEntryId": "fwd-5tf66679oi2uoxcvlg0g2****",
      "ExternalIp": "120.XXX.XXX.70",
      "ExternalPort": "22",
      "InternalIp": "10.XXX.XXX.3",
      "InternalPort": "22",
      "ForwardEntryName": "test0",
      "Status": "Available",
      "IpProtocol": "Any",
      "HealthCheckPort": "80",
      "StandbyExternalIp": "101.XXX.XXX.7",
      "StandbyStatus": "Stopped"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Invalid%sThe specified parameter %s is invalid.参数不正确
400Missing%sYou must specify the parameter %s.参数为必填
400ens.interface.error An error occurred while call the API. -
400InvalidParameter.NatNotFoundThe specified Nat is not found.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-07-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈