DescribeRouteEntryList - 查询路由条目列表

调用DescribeRouteEntryList查询路由条目列表。

接口说明

调用 DeleteRouteEntry 接口删除路由条目前,您可以调用本接口查询要删除的路由条目的下一跳信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

路由条目所在路由表的地域 ID。

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

cn-hangzhou
RouteTableIdstring

要查询的路由表的 ID。

vtb-bp1r9pvl4xen8s9ju****
RouteEntryIdstring

要查询的路由条目的 ID。

rte-bp1mnnr2al0naomnp****
DestinationCidrBlockstring

路由条目的目标网段,支持 IPv4 和 IPv6 网段。

192.168.2.0/24
RouteEntryNamestring

路由条目的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

abc
IpVersionstring

IP 协议的版本。取值:

  • ipv4:ipv4 协议。

  • ipv6:ipv6 协议。

ipv4
RouteEntryTypestring

路由的类型。取值:

  • Custom:自定义路由。
  • System:系统路由。
  • BGP:BGP 路由。
  • CEN:云企业网 CEN(Cloud Enterprise Network)路由。
  • ECR:专线网关路由。
System
NextHopIdstring

下一跳实例 ID。

vpn-bp10zyaph5cc8b7c7****
NextHopTypestring

下一跳类型。取值:

  • Instance(默认值):ECS 实例。

  • HaVip:高可用虚拟 IP。

  • VpnGateway:VPN 网关。

  • NatGateway:NAT 网关。

  • NetworkInterface:辅助弹性网卡。

  • RouterInterface:路由器接口。

  • IPv6Gateway:IPv6 网关。

  • Attachment:转发路由器。

  • Ipv4Gateway:IPv4 网关。

  • GatewayEndpoint:网关终端节点。

  • Ecr:专线网关。

Instance
MaxResultinteger

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

10
NextTokenstring

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

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

路由托管的类型。如果该字段为空,即表示该路由没有被托管。

取值:TR,表示托管类型为转发路由器类型。

TR
DestCidrBlockListarray

路由条目的目标网段列表。

string

路由条目的目标网段列表信息。最多支持输入 20 个目标网段。

192.168.0.0/24

返回参数

名称类型描述示例值
object

路由条目详细信息。

NextTokenstring

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

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

请求 ID。

14A07460-EBE7-47CA-9757-12CC4761D47A
RouteEntrysarray<object>

路由条目信息。

object

路由条目信息。

Statusstring

路由条目的状态。取值:

  • Pending:配置中。

  • Available:可用。

  • Modifying:修改中。

Available
Typestring

路由条目的类型。取值:

  • Custom:自定义路由。
  • System:系统路由。
  • BGP:BGP 路由。
  • CEN:云企业网 CEN(Cloud Enterprise Network)路由。
  • ECR:专线网关路由。
System
IpVersionstring

IP 协议的版本。取值:

  • ipv4:ipv4 协议。

  • ipv6:ipv6 协议。

ipv4
Descriptionstring

路由条目的描述信息。

RouteEntryDescription
RouteEntryNamestring

路由条目的名称。

aaa
DestinationCidrBlockstring

路由条目的目标网段。

192.168.2.0/24
RouteEntryIdstring

路由条目的 ID。

rte-bp1mnnr2al0naomnp****
RouteTableIdstring

路由表 ID。

vtb-bp15w5q90d2rk3bww****
GmtModifiedstring

路由条目的修改时间。使用 UTC 时间,格式为YYYY-MM-DDThh:mm:ssZ

2022-05-09T03:00:07Z
NextHopsarray<object>

下一跳信息。

object

下一跳信息。

NextHopRegionIdstring

下一跳实例所在的地域 ID。

说明 下一跳类型为 RouterInterface 时返回该参数。
cn-hangzhou
Weightinteger

路由条目的权重。

说明 下一跳类型为 RouterInterface 时返回该参数。
100
NextHopIdstring

下一跳实例 ID。

vpn-bp10zyaph5cc8b7c7****
Enabledinteger

路由是否可用。取值:

  • 0:不可用。

  • 1:可用。

说明 下一跳类型为 RouterInterface 时返回该参数。
1
NextHopTypestring

下一跳类型。取值:

  • Instance:ECS 实例。

  • HaVip:高可用虚拟 IP。

  • VpnGateway:VPN 网关。

  • NatGateway:NAT 网关。

  • NetworkInterface:辅助弹性网卡。

  • RouterInterface:路由器接口。

  • IPv6Gateway:IPv6 网关。

  • Attachment:转发路由器。

  • Ipv4Gateway:IPv4 网关。

  • GatewayEndpoint:网关终端节点。

  • Ecr:专线网关。

Instance
NextHopRelatedInfoobject

下一跳相关信息。

InstanceIdstring

与下一跳相关联实例的实例 ID。

vpc-bp1t36rn9l53iwbsf****
InstanceTypestring

与下一跳相关联实例的实例类型。取值:

  • VPC:专有网络。

  • VBR:边界路由器。

  • PCONN:物理专线。

VPC
RegionIdstring

下一跳相关联实例所在的地域 ID。

ch-hangzhou
ServiceTypestring

路由托管的类型。如果该字段为空,即表示该路由没有被托管。

取值:TR,表示托管类型为转发路由器类型。

TR
Originstring

路由创建来源。取值:

  • RoutePropagation:动态传播源创建。
  • SystemCreate:系统创建。
  • CustomCreate:自定义创建。
RoutePropagation

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys": {
    "RouteEntry": [
      {
        "Status": "Available",
        "Type": "System",
        "IpVersion": "ipv4",
        "Description": "RouteEntryDescription",
        "RouteEntryName": "aaa",
        "DestinationCidrBlock": "192.168.2.0/24",
        "RouteEntryId": "rte-bp1mnnr2al0naomnp****",
        "RouteTableId": "vtb-bp15w5q90d2rk3bww****",
        "GmtModified": "2022-05-09T03:00:07Z",
        "NextHops": {
          "NextHop": [
            {
              "NextHopRegionId": "cn-hangzhou",
              "Weight": 100,
              "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
              "Enabled": 1,
              "NextHopType": "Instance",
              "NextHopRelatedInfo": {
                "InstanceId": "vpc-bp1t36rn9l53iwbsf****",
                "InstanceType": "VPC",
                "RegionId": "ch-hangzhou"
              }
            }
          ]
        },
        "ServiceType": "TR",
        "Origin": "RoutePropagation"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenUser nextToken is illegal.-
400InvalidNextHop.NotFoundThe specified route entry nexthop does not exist in our records.-
400OperationFailed.QueryCenEntryOperation is denied because getting CEN route entry has failed.由于暂时无法获取云企业网路由导致查询失败。
400OperationDenied.UseGatewayRouteEntryQueryInterfaceUse listGatewayRouteTableEntries to describe gateway route entries.查询网关路由表路由条目,请使用listGatewayRouteTableEntries接口。
400InvalidRouteTable.NotFoundThe specified RouteTable was not found.指定的路由表未找到。
400IllegalParam.RouteEntryTypeThe parameter of RouteEntryType is illegal.参数RouteEntryType非法。
400MissingParam.contextThe param of context is missing.参数context缺失。
400MissingParam.aliUidThe param of aliUid is missing.参数aliUid缺失。
400MissingParam.bidThe param of bid is missing.参数bid缺失。
400IllegalParam.IpVersionParam IpVersion illegal.非法参数:IpVersion。
400OperationFailed.FilterParamUnderWrongRouteTypeOperation failed because only custom type support filter by routeEntryId or routeEntryName操作失败,只有自定义路由条目才支持通过路由条目id或路由条目名进行过滤
400IllegalParam.NextTokenExpiredThe parameter of NextTokenExpired is illegal.参数NextTokenExpired非法。

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

变更历史

变更时间变更内容概要操作
2024-08-26OpenAPI 错误码发生变更查看变更详情
2024-01-05OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-07-03OpenAPI 错误码发生变更查看变更详情