全部產品
Search

搜尋本產品

    Virtual Private Cloud：DescribeRouteEntryList

    文件中心

    Virtual Private Cloud：DescribeRouteEntryList

    更新時間：Jul 16, 2026

    呼叫 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

    object

    RouteEntry

    array<object>

    路由項目資訊。

    array<object>

    路由項目資訊。

    Status

    string

    路由項目的狀態。取值：

    • Pending：設定中。

    • Available：可用。

    • Modifying：修改中。

    • Deleting：刪除中。

    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

    object

    NextHop

    array<object>

    下一跳資訊。

    array<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.
    400 MissingParam.bid The param of bid is missing. 參數 bid 缺失。
    400 IllegalParam.IpVersion Param IpVersion illegal.
    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 無效。
    400 IllegalParam.CidrBlock The param of (%s) is illegal. CidrBlock 參數不合法。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。