文档

ListGatewayRouteTableEntries - 查询网关路由表列表信息

更新时间:

调用ListGatewayRouteTableEntries接口查询网关路由表列表信息。

调试

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

授权信息

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

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

请求参数

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

要查询网关路由表列表信息的地域 ID。

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

ap-southeast-6
MaxResultsinteger

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

10
NextTokenstring

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

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

要查询的网关路由表 ID。

vtb-5ts0ohchwkp3dydt2****
DestinationCidrBlockstring

要查询的网关路由表中路由条目的目标网段。

192.168.0.5

返回参数

名称类型描述示例值
object

网关路由表列表信息。

NextTokenstring

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

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

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
TotalCountstring

列表条目数。

1
GatewayRouteEntryModelsobject []

网关路由表中路由条目的详细信息。

Statusstring

路由条目的状态。

  • Pending:配置中。
  • Available:可用。
  • Modifying:修改中。
Available
NextHopIdstring

下一跳实例 ID。

i-bp11gcl0sm85t9bi****
Descriptionstring

路由条目的名称。

test
NextHopTypestring

下一跳的类型。取值:

  • EcsInstance:ECS 实例。
  • NetworkInterface:弹性网卡。
  • Local:本地。
EcsInstance
DestinationCidrBlockstring

路由条目的目标网段。

192.168.0.5
Namestring

路由条目的名称。

长度为 2~128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

name
NextHopsobject []

下一跳信息。

NextHopIdstring

下一跳实例 ID。

vpn-bp10zyaph5cc8b7c7****
NextHopTypestring

下一跳类型。取值:

  • Instance(默认值):ECS 实例。
  • HaVip:高可用虚拟 IP。
  • VpnGateway:VPN 网关。
  • NatGateway:NAT 网关。
  • NetworkInterface:辅助弹性网卡。
  • RouterInterface:路由器接口。
  • IPv6Gateway:IPv6 网关。
  • Attachment:转发路由器。
Instance
Weightstring

路由条目的权重。

100
Enabledstring

路由是否可用。取值:

  • 0:不可用。
  • 1:可用。
1

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "TotalCount": "1",
  "GatewayRouteEntryModels": [
    {
      "Status": "Available",
      "NextHopId": "i-bp11gcl0sm85t9bi****",
      "Description": "test",
      "NextHopType": "EcsInstance",
      "DestinationCidrBlock": "192.168.0.5",
      "Name": "name",
      "NextHops": [
        {
          "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
          "NextHopType": "Instance",
          "Weight": "100",
          "Enabled": "1"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.GatewayRouteTableThe specified resource GatewayRouteTable is not found.无法找到指定的网关路由表
400IllegalParam.NextTokenThe param of nextToken is illegal-

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

变更历史

变更时间变更内容概要操作
2023-08-07OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈