DescribeRouteEntryList - 查询路由条目列表 - 专有网络 VPC

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

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeRouteEntryList	get	RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	路由条目所在路由表的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
RouteTableId	string	是	要查询的路由表的 ID。	vtb-bp1r9pvl4xen8s9ju****
RouteEntryId	string	否	要查询的路由条目的 ID。	rte-bp1mnnr2al0naomnp****
DestinationCidrBlock	string	否	路由条目的目标网段，支持 IPv4 和 IPv6 网段。	192.168.2.0/24
RouteEntryName	string	否	路由条目的名称。名称长度为 1～128 个字符，不能以`http://`或`https://`开头。	abc
IpVersion	string	否	IP 协议的版本。取值： ipv4：ipv4 协议。 ipv6：ipv6 协议。	ipv4
RouteEntryType	string	否	路由的类型。取值： Custom：自定义路由。 System：系统路由。 BGP：BGP 路由。 CEN：云企业网 CEN（Cloud Enterprise Network）路由。 ECR：专线网关路由。	System
NextHopId	string	否	下一跳实例 ID。	vpn-bp10zyaph5cc8b7c7****
NextHopType	string	否	下一跳类型。取值： Instance（默认值）：ECS 实例。 HaVip：高可用虚拟 IP。 VpnGateway：VPN 网关。 NatGateway：NAT 网关。 NetworkInterface：辅助弹性网卡。 RouterInterface：路由器接口。 IPv6Gateway：IPv6 网关。 Attachment：转发路由器。 Ipv4Gateway：IPv4 网关。 GatewayEndpoint：网关终端节点。 Ecr：专线网关。	Instance
MaxResult	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 10。	10
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
ServiceType	string	否	路由托管的类型。如果该字段为空，即表示该路由没有被托管。取值：TR，表示托管类型为转发路由器类型。	TR
DestCidrBlockList	array	否	路由条目的目标网段列表。
	string	否	路由条目的目标网段列表信息。最多支持输入 20 个目标网段。	192.168.0.0/24

返回参数

名称	类型	描述	示例值
	object	路由条目详细信息。
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	14A07460-EBE7-47CA-9757-12CC4761D47A
RouteEntrys	array<object>	路由条目信息。
RouteEntry	object	路由条目信息。
Status	string	路由条目的状态。取值： Pending：配置中。 Available：可用。 Modifying：修改中。	Available
Type	string	路由条目的类型。取值： Custom：自定义路由。 System：系统路由。 BGP：BGP 路由。 CEN：云企业网 CEN（Cloud Enterprise Network）路由。 ECR：专线网关路由。	System
IpVersion	string	IP 协议的版本。取值： ipv4：ipv4 协议。 ipv6：ipv6 协议。	ipv4
Description	string	路由条目的描述信息。	RouteEntryDescription
RouteEntryName	string	路由条目的名称。	aaa
DestinationCidrBlock	string	路由条目的目标网段。	192.168.2.0/24
RouteEntryId	string	路由条目的 ID。	rte-bp1mnnr2al0naomnp****
RouteTableId	string	路由表 ID。	vtb-bp15w5q90d2rk3bww****
GmtModified	string	路由条目的修改时间。使用 UTC 时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2022-05-09T03:00:07Z
NextHops	array<object>	下一跳信息。
NextHop	object	下一跳信息。
NextHopRegionId	string	下一跳实例所在的地域 ID。说明下一跳类型为 RouterInterface 时返回该参数。	cn-hangzhou
Weight	integer	路由条目的权重。说明下一跳类型为 RouterInterface 时返回该参数。	100
NextHopId	string	下一跳实例 ID。	vpn-bp10zyaph5cc8b7c7****
Enabled	integer	路由是否可用。取值： 0：不可用。 1：可用。说明下一跳类型为 RouterInterface 时返回该参数。	1
NextHopType	string	下一跳类型。取值： Instance：ECS 实例。 HaVip：高可用虚拟 IP。 VpnGateway：VPN 网关。 NatGateway：NAT 网关。 NetworkInterface：辅助弹性网卡。 RouterInterface：路由器接口。 IPv6Gateway：IPv6 网关。 Attachment：转发路由器。 Ipv4Gateway：IPv4 网关。 GatewayEndpoint：网关终端节点。 Ecr：专线网关。	Instance
NextHopRelatedInfo	object	下一跳相关信息。
InstanceId	string	与下一跳相关联实例的实例 ID。	vpc-bp1t36rn9l53iwbsf****
InstanceType	string	与下一跳相关联实例的实例类型。取值： VPC：专有网络。 VBR：边界路由器。 PCONN：物理专线。	VPC
RegionId	string	下一跳相关联实例所在的地域 ID。	ch-hangzhou
ServiceType	string	路由托管的类型。如果该字段为空，即表示该路由没有被托管。取值：TR，表示托管类型为转发路由器类型。	TR
Origin	string	路由创建来源。取值： 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	错误码	错误信息	描述
400	IllegalParam.NextToken	User nextToken is illegal.	-
400	InvalidNextHop.NotFound	The specified route entry nexthop does not exist in our records.	-
400	OperationFailed.QueryCenEntry	Operation is denied because getting CEN route entry has failed.	由于暂时无法获取云企业网路由导致查询失败。
400	OperationDenied.UseGatewayRouteEntryQueryInterface	Use listGatewayRouteTableEntries to describe gateway route entries.	查询网关路由表路由条目，请使用listGatewayRouteTableEntries接口。
400	InvalidRouteTable.NotFound	The specified RouteTable was not found.	指定的路由表未找到。
400	IllegalParam.RouteEntryType	The parameter of RouteEntryType is illegal.	参数RouteEntryType非法。
400	MissingParam.context	The param of context is missing.	参数context缺失。
400	MissingParam.aliUid	The param of aliUid is missing.	参数aliUid缺失。
400	MissingParam.bid	The param of bid is missing.	参数bid缺失。
400	IllegalParam.IpVersion	Param IpVersion illegal.	非法参数：IpVersion。
400	OperationFailed.FilterParamUnderWrongRouteType	Operation failed because only custom type support filter by routeEntryId or routeEntryName	操作失败，只有自定义路由条目才支持通过路由条目id或路由条目名进行过滤
400	IllegalParam.NextTokenExpired	The parameter of NextTokenExpired is illegal.	参数NextTokenExpired非法。

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

变更历史

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