全部產品
Search

搜尋本產品

    Virtual Private Cloud：DescribeRouteTables

    文件中心

    Virtual Private Cloud：DescribeRouteTables

    更新時間：Jun 19, 2026

    呼叫 DescribeRouteTables 介面查詢路由表。

    說明

    目前該API介面已標記為棄用，推薦使用替代API：Vpc(2016-04-28) - DescribeRouteTableList。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vpc:DescribeRouteTables

    list

    *RouteTable

    acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}
    • vpc:VBR
    • vpc:VRouter
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    要查詢的路由表所屬的 VPC 的地域 ID。

    您可以透過呼叫 DescribeRegions 介面取得地域 ID。

    ap-southeast-6
    VRouterId

    string

    否

    要查詢的路由器的 ID。

    說明

    VRouterId，RouteTableId，RouterId 和 RouteTableName 參數至少需要輸入一個，但是不能同時輸入 VRouterId 和 RouterId 參數。

    vrt-bp1lhl0taikrteen****
    RouteTableId

    string

    否

    要查詢的路由表的 ID。

    說明

    VRouterId，RouteTableId，RouterId 和 RouteTableName 參數至少需要輸入一個，但是不能同時輸入 VRouterId 和 RouterId 參數。

    vtb-bp145q7glnuzdvzu2****
    RouterType

    string

    否

    要查詢的路由表所屬的路由器的類型。取值：

    • VRouter（預設值）：VPC 路由器。

    • VBR：邊界路由器。

    VRouter
    RouterId

    string

    否

    要查詢的路由表所屬路由器的 ID。

    說明

    VRouterId，RouteTableId，RouterId 和 RouteTableName 參數至少需要輸入一個，但是不能同時輸入 VRouterId 和 RouterId 參數。

    vrt-bp1lhl0taikrteen8****
    Type

    string

    否

    要查詢的路由條目的類型。取值：

    • Custom：自訂路由。

    • System：系統路由。

    • BGP：BGP 路由。

    • CEN：雲端企業網 CEN（Cloud Enterprise Network）路由。

    • ECR：專線閘道路由。

    Custom
    RouteTableName

    string

    否

    要查詢的路由表的名稱。

    名稱長度為 2~128 個字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短橫線（-）。

    說明

    VRouterId，RouteTableId，RouterId 和 RouteTableName 參數至少需要輸入一個，但是不能同時輸入 VRouterId 和 RouterId 參數。

    doctest
    ResourceGroupId

    string

    否

    要查詢的路由表所屬資源群組的 ID。

    rg-acfmxazb4ph****
    PageNumber

    integer

    否

    列表的頁碼，預設值為 1。

    1
    PageSize

    integer

    否

    分頁查詢時每頁的行數，最大值為 50，預設值為 10。

    10

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    每頁包含的條目數。

    PageSize

    integer

    每頁包含的條目數。

    10
    RequestId

    string

    請求 ID。

    DC668356-BCB4-42FD-9BC3-FA2B2E04B634
    PageNumber

    integer

    目前頁碼。

    1
    TotalCount

    integer

    列表條目數。

    1
    RouteTables

    object

    RouteTable

    array<object>

    路由表列表詳細資訊。

    array<object>

    路由表的建立時間。

    CreationTime

    string

    路由表的建立時間。

    使用 UTC 時間，格式為YYYY-MM-DDThh:mm:ssZ。

    2022-08-22T10:40:25Z
    Status

    string

    路由表的狀態。取值：

    • Pending：配置中。

    • Available：可用。

    Available
    VRouterId

    string

    路由器的 ID。

    vrt-bp1lhl0taikrteen****
    RouteTableType

    string

    路由表的類型。取值：

    • Custom：自訂路由表。

    • System：系統路由表。

    Custom
    ResourceGroupId

    string

    路由表所屬資源群組的 ID。

    rg-acfmxazb4ph****
    RouteTableId

    string

    路由表的 ID。

    vtb-bp145q7glnuzdvzu2****
    RouteEntrys

    object

    RouteEntry

    array<object>

    路由條目資訊。

    array<object>

    路由條目資訊。

    Type

    string

    路由條目的類型。取值：

    • Custom：自訂路由。

    • System：系統路由。

    • BGP：BGP 路由。

    • CEN：雲企業網 CEN（Cloud Enterprise Network）路由。

    • ECR：專線網關路由。

    Custom
    Status

    string

    路由條目的狀態。取值：

    • Pending：配置中。

    • Available：可用。

    • Modifying：修改中。

    Available
    NextHopType

    string

    下一跳類型。取值：

    • Instance（預設值）：ECS 執行個體。

    • HaVip：高可用虛擬 IP。

    • VpnGateway：VPN 閘道。

    • NatGateway：NAT Gateway。

    • NetworkInterface：輔助彈性網卡。

    • RouterInterface：路由器介面。

    • IPv6Gateway：IPv6 網關。

    • Attachment：轉寄路由器。

    • Ipv4Gateway：IPv4 網關。

    • GatewayEndpoint：網關終端節點。

    • CenBasic：CEN 不支援轉寄路由器。

    • Ecr：專線網關。

    Instance
    RouteEntryName

    string

    路由條目的名稱。

    名稱長度為 2~128 個字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。

    name
    RouteEntryId

    string

    路由條目的 ID。

    rte-bp1mnnr2al0naomnp****
    InstanceId

    string

    與下一跳相關聯執行個體的執行個體 ID。

    vpc-bp1t36rn9l53iwbsf****
    RouteTableId

    string

    路由表 ID。

    vtb-bp15w5q90d2rk3bww****
    Description

    string

    路由條目的描述資訊。 描述長度為 2~256 個字元，必須以字母或中文開頭，但不能以http://或https://開頭。

    RouteEntryDescription
    DestinationCidrBlock

    string

    路由條目的目標網段。支援 IPv4 和 IPv6 的目標網段。需滿足以下要求：

    • 目標網段不能指向 100.64.0.0/10 或被 100.64.0.0/10 包含。

    • 同一張路由表內的不同路由條目的目標網段不能相同。

    192.168.2.0/24
    NextHops

    object

    NextHop

    array<object>

    下一跳資訊。

    object

    下一跳資訊。

    NextHopId

    string

    下一跳執行個體 ID。

    vpn-bp10zyaph5cc8b7c7****
    Weight

    integer

    路由條目的權重。

    100
    NextHopType

    string

    下一跳類型。取值：

    • Instance：ECS 執行個體。

    • HaVip：高可用虛擬 IP。

    • VpnGateway：VPN 閘道。

    • NatGateway：NAT Gateway。

    • NetworkInterface：輔助彈性網卡。

    • RouterInterface：路由器介面。

    • IPv6Gateway：IPv6 網關。

    • Attachment：轉寄路由器。

    • Ipv4Gateway：IPv4 網關。

    • GatewayEndpoint：網關終端節點。

    • CenBasic：CEN 不支援轉寄路由器。

    • Ecr：專線網關。

    Instance
    Enabled

    integer

    路由是否可用。取值：

    • 0：不可用。

    • 1：可用。

    1
    VSwitchIds

    object

    VSwitchId

    array

    交換器 ID。

    string

    交換器 ID。

    vsw-bp12mw1f8k3jgygk9****

    樣本

    正常返回樣本

    JSON格式

    {
  "PageSize": 10,
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteTables": {
    "RouteTable": [
      {
        "CreationTime": "2022-08-22T10:40:25Z",
        "Status": "Available",
        "VRouterId": "vrt-bp1lhl0taikrteen****",
        "RouteTableType": "Custom",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "RouteTableId": "vtb-bp145q7glnuzdvzu2****",
        "RouteEntrys": {
          "RouteEntry": [
            {
              "Type": "Custom",
              "Status": "Available",
              "NextHopType": "Instance",
              "RouteEntryName": "name",
              "RouteEntryId": "rte-bp1mnnr2al0naomnp****",
              "InstanceId": "vpc-bp1t36rn9l53iwbsf****",
              "RouteTableId": "vtb-bp15w5q90d2rk3bww****",
              "Description": "RouteEntryDescription",
              "DestinationCidrBlock": "192.168.2.0/24",
              "NextHops": {
                "NextHop": [
                  {
                    "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
                    "Weight": 100,
                    "NextHopType": "Instance",
                    "Enabled": 1
                  }
                ]
              }
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp12mw1f8k3jgygk9****"
          ]
        }
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidVRouterId.NotFound Specified virtual router does not exist.
    400 OperationFailed.DescribeCenRoute An error occurred while querying the CEN route entry.
    400 OperationFailed.VRouterNotExist Operation failed because the VRouter does not exist.
    400 IllegalParam.Type The parameter of Type is illegal.
    400 OperationFailed.InvalidRouterType The operation is failed because of %s.

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

    變更歷史

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