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

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

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

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

RouteTableId String vtb-bp1r9pvl4xen8s9ju****

要查询的路由表的ID。

RouteEntryId String rte-bp1mnnr2al0naomnp****

要查询的路由条目的ID。

DestinationCidrBlock String 192.168.2.0/24

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

RouteEntryName String abc

路由条目的名称。

IpVersion String IPv4

IP协议的版本。取值:

  • IPv4:IPv4协议。
  • IPv6:IPv6协议。
RouteEntryType String System

路由条目的类型。取值:

  • Custom:自定义路由。
  • System:系统路由。
  • BGP:BGP路由。
  • CEN:云企业网CEN(Cloud Enterprise Network)路由。
NextHopId String vpn-bp10zyaph5cc8b7c7****

下一跳实例ID。

NextHopType String Instance

下一跳类型。取值:

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

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

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

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

系统规定参数。取值:DescribeRouteEntryList

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

请求ID。

RouteEntrys Array of RouteEntry

路由条目信息。

RouteEntry
Status String Available

路由条目的状态。取值:

  • Pending:配置中。
  • Available:可用。
  • Modifying:修改中。
Type String Custom

路由条目的类型。取值:

  • Custom:自定义路由。
  • System:系统路由。
  • BGP:BGP路由。
  • CEN:云企业网CEN(Cloud Enterprise Network)路由。
IpVersion String IPv4

IP协议的版本。取值:

  • IPv4:IPv4协议。
  • IPv6:IPv6协议。
Description String RouteEntryDescription

路由条目的描述信息。

RouteEntryName String aaa

路由条目的名称。

DestinationCidrBlock String 192.168.2.0/24

路由条目的目标网段。

RouteEntryId String rte-bp1mnnr2al0naomnp****

路由条目的ID。

RouteTableId String vtb-bp15w5q90d2rk3bww****

路由表ID。

NextHops Array of NextHop

下一跳信息。

NextHop
NextHopRegionId String cn-hangzhou

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

Weight Integer 100

路由条目的权重。

NextHopId String vpn-bp10zyaph5cc8b7c7****

下一跳实例ID。

Enabled Integer 1

路由是否可用。取值:

  • 0:不可用。
  • 1:可用。
NextHopType String Instance

下一跳类型。取值:

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

下一跳相关信息。

InstanceId String vpc-bp1t36rn9l53iwbsf****

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

InstanceType String VPC

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

  • VPC:专有网络。
  • VBR:边界路由器。
  • PCONN:物理专线。
RegionId String ch-hangzhou

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

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&RouteTableId=vtb-bp1r9pvl4xen8s9ju****
&RouteEntryId=rte-bp1mnnr2al0naomnp****
&DestinationCidrBlock=192.168.2.0/24
&RouteEntryName=abc
&IpVersion=IPv4
&RouteEntryType=System
&NextHopId=vpn-bp10zyaph5cc8b7c7****
&NextHopType=Instance
&MaxResult=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Action=DescribeRouteEntryList
&公共请求参数

正常返回示例

XML格式

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

<DescribeRouteEntryListResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <RouteEntrys>
        <Status>Available</Status>
        <Type>Custom</Type>
        <IpVersion>IPv4</IpVersion>
        <Description>RouteEntryDescription</Description>
        <RouteEntryName>aaa</RouteEntryName>
        <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
        <RouteEntryId>rte-bp1mnnr2al0naomnp****</RouteEntryId>
        <RouteTableId>vtb-bp15w5q90d2rk3bww****</RouteTableId>
        <NextHops>
            <NextHopRegionId>cn-hangzhou</NextHopRegionId>
            <Weight>100</Weight>
            <NextHopId>vpn-bp10zyaph5cc8b7c7****</NextHopId>
            <Enabled>1</Enabled>
            <NextHopType>Instance</NextHopType>
            <NextHopRelatedInfo>
                <InstanceId>vpc-bp1t36rn9l53iwbsf****</InstanceId>
                <InstanceType>VPC</InstanceType>
                <RegionId>ch-hangzhou</RegionId>
            </NextHopRelatedInfo>
        </NextHops>
    </RouteEntrys>
</DescribeRouteEntryListResponse>

JSON格式

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys" : [ {
    "Status" : "Available",
    "Type" : "Custom",
    "IpVersion" : "IPv4",
    "Description" : "RouteEntryDescription",
    "RouteEntryName" : "aaa",
    "DestinationCidrBlock" : "192.168.2.0/24",
    "RouteEntryId" : "rte-bp1mnnr2al0naomnp****",
    "RouteTableId" : "vtb-bp15w5q90d2rk3bww****",
    "NextHops" : [ {
      "NextHopRegionId" : "cn-hangzhou",
      "Weight" : 100,
      "NextHopId" : "vpn-bp10zyaph5cc8b7c7****",
      "Enabled" : 1,
      "NextHopType" : "Instance",
      "NextHopRelatedInfo" : {
        "InstanceId" : "vpc-bp1t36rn9l53iwbsf****",
        "InstanceType" : "VPC",
        "RegionId" : "ch-hangzhou"
      }
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationFailed.QueryCenEntry Operation is denied because getting CEN route entry has failed. 由于暂时无法获取云企业网路由导致查询失败。

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