全部產品
Search

搜尋本產品

    ：ListTransitRouterRouteEntries - 查詢企業版轉寄路由器路由表中的路由條目資訊

    文件中心

    ：ListTransitRouterRouteEntries - 查詢企業版轉寄路由器路由表中的路由條目資訊

    更新時間：Dec 14, 2025

    調用ListTransitRouterRouteEntries介面查詢企業版轉寄路由器路由表中的路由條目的詳細資料。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cen:ListTransitRouterRouteEntries

    get

    TransitRouterRouteEntry

    acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

    TransitRouterRouteTable

    acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

    TransitRouterRouteEntry

    acs:cen:*:{#accountId}:centransitrouterroutentry/*

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    MaxResults

    integer

    否

    分批次查詢時，每次顯示的條目數。取值範圍：1~100。預設值：20。

    20
    TransitRouterRouteEntryDestinationCidrBlock deprecated

    string

    否

    路由條目的目標網段（本參數即將廢棄，建議使用 RouteFilter 參數）。

    192.168.0.0/24
    TransitRouterRouteEntryStatus

    string

    否

    路由條目的狀態。取值：

    • All：表示查詢全部狀態的路由條目。

    • Active（預設值）：表示僅查詢生效狀態的路由條目。

    • Rejected：表示僅查詢因路由衝突而被拒絕的路由條目。

    • Prohibited：表示僅查詢因匹配到路由策略而被禁止的路由條目。

    • Standby：表示僅查詢作為備份的路由條目。

    • Candidate：表示僅查詢作為候選的路由條目。

    如果您未指定本參數的值，系統預設僅查詢生效狀態的路由條目。

    Active
    TransitRouterRouteTableId

    string

    是

    企業版轉寄路由器路由表 ID。

    vtb-bp1dudbh2d5na6b50****
    NextToken

    string

    否

    是否擁有下一次查詢的令牌（Token）。取值：

    • 第一次查詢和沒有下一次查詢時，均無需填寫。

    • 如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。

    fce19****
    TransitRouterRouteEntryNames

    array

    否

    路由條目的名稱。

    testname

    string

    否

    路由條目的名稱。

    名稱可以為空白或長度為 1～128 個字元，不能以 http://或 https://開頭。

    說明

    系統僅支援通過本參數查詢當前路由表上靜態配置的路由，且與 TransitRouterRouteEntryIds 之外的其他查詢條件不相容。

    testname
    TransitRouterRouteEntryIds

    array

    否

    路由條目 ID。

    rte-oklkgwmj97z6dn****

    string

    否

    路由條目 ID。

    說明

    系統僅支援通過本參數查詢當前路由表上靜態配置的路由，且與 TransitRouterRouteEntryNames 之外的其他查詢條件不相容。

    rte-oklkgwmj97z6dn****
    TransitRouterRouteEntryType

    string

    否

    路由條目的類型。取值：

    • Propagated：當前路由表自動學習產生。

    • Static：當前路由表靜態配置產生。

    Propagated
    TransitRouterRouteEntryNextHopType

    string

    否

    下一跳類型。取值：

    • BlackHole：表示指定該路由條目為黑洞路由。

    • Attachment：表示指定該路由條目的下一跳為網路執行個體串連。

    Attachment
    TransitRouterRouteEntryNextHopId

    string

    否

    路由條目的下一跳所關聯的網路執行個體串連 ID。

    tr-attach-nls9fzkfat8934****
    TransitRouterRouteEntryNextHopResourceId

    string

    否

    路由條目的下一跳執行個體 ID。

    vpc-m5ent6du8deaq5*****
    TransitRouterRouteEntryNextHopResourceType

    string

    否

    路由條目的下一跳執行個體類型。取值：

    • VPC：Virtual Private Cloud（Virtual Private Cloud）執行個體。

    • VBR：邊界路由器 VBR（Virtual Border Router）執行個體。

    • TR：轉寄路由器執行個體。

    • VPN：IPsec 串連執行個體。

    VPC
    TransitRouterRouteEntryOriginResourceId

    string

    否

    路由條目的起源執行個體 ID。

    vpc-m5ent6du8deaq5*****
    TransitRouterRouteEntryOriginResourceType

    string

    否

    路由條目的起源執行個體類型。取值：

    • VPC：Virtual Private Cloud（Virtual Private Cloud）執行個體。

    • VBR：邊界路由器 VBR（Virtual Border Router）執行個體。

    • TR：轉寄路由器執行個體。

    • VPN：IPsec 串連執行個體。

    VPC
    PrefixListId

    string

    否

    首碼列表 ID。

    pl-6ehtn5kqxgeyy08fi****
    RouteFilter

    array<object>

    否

    路由條目網段過濾的條件資訊。

    object

    否

    路由條目網段過濾條件資訊。

    Key

    string

    否

    過濾條件。取值：

    • PrefixExactMatchCidrs：精確匹配。

    • LongestPrefixMatchCidrs：最長首碼匹配，支援傳入 IP 和 CIDR。

    • SubnetOfMatchCidrs：子網匹配，匹配傳入的 CIDR 的子網，含傳入的 CIDR。

    • SupernetOfMatchCidrs：超網匹配，匹配傳入的 CIDR 的超網，含傳入的 CIDR。

    多個過濾條件之間預設是與的關係，即必須符合所有過濾條件，才視為匹配過濾條件。不能重複傳入相同的過濾條件。

    PrefixExactMatchCidrs
    Value

    array

    否

    過濾條件值的列表。

    string

    否

    根據 Key 指定過濾值。一個 Key 支援指定多個過濾值，多個過濾值之間是或的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。 一個過濾條件最多支援輸入 500 個過濾值。
    支援 IPv4、IPv6 類型的地址和 CIDR。

    192.168.1.0/24

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    NextToken

    string

    是否擁有下一次查詢的令牌（Token）。取值：

    • 如果 NextToken 為空白表示沒有下一次查詢。

    • 如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。

    fce19****
    RequestId

    string

    請求 ID。

    C3835E5E-1504-4344-B1BB-98A4110F1079
    TotalCount

    integer

    總條目數。

    6
    MaxResults

    integer

    分批次查詢時，每次顯示的條目數。

    20
    TransitRouterRouteEntries

    array<object>

    路由條目資訊列表。

    object

    路由條目資訊。

    TransitRouterRouteEntryId

    string

    路由條目 ID。

    說明

    只有靜態配置的路由才會返回該參數值。

    rte-oklkgwmj97z6dn****
    TransitRouterRouteEntryDestinationCidrBlock

    string

    路由條目的目標網段，返回 IPv4 位址區段或者 IPv6 位址區段。

    192.168.0.0/24
    TransitRouterRouteEntryType

    string

    路由條目的類型。

    • Static：表示該路由條目為靜態配置的路由。

    • Propagated：表示該路由條目為自動學習到的路由。

    Static
    CreateTime

    string

    路由條目的建立時間。

    時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mmZ。

    說明

    只有靜態配置的路由才會返回該參數值。

    2021-06-15T07:01Z
    TransitRouterRouteEntryName

    string

    路由條目的名稱。

    說明

    只有靜態配置的路由才會返回該參數值。

    testname
    TransitRouterRouteEntryStatus

    string

    路由條目的生效狀態。

    • Active：生效。

    • Rejected：路由衝突拒絕。

    • Prohibited：路由策略禁止。

    • Standby：備份。

    • Candidate：候選。

    • Creating：添加中。

    • Deleting：刪除中。

    Active
    TransitRouterRouteEntryNextHopType

    string

    路由條目的下一跳類型。

    • BlackHole：表示該路由條目為黑洞路由，所有去往目標網段的路由均會被丟棄。

    • Attachment：表示該路由條目的下一跳為網路執行個體串連，所有去往目標網段的路由均會被轉寄至指定的網路執行個體串連。

    BlackHole
    TransitRouterRouteEntryNextHopId

    string

    路由條目的下一跳 ID。黑洞路由不會返回該參數值。

    tr-attach-vx6iwhjr1x1j78****
    TransitRouterRouteEntryDescription

    string

    路由條目的描述資訊。

    說明

    只有靜態配置的路由才會返回該參數值。

    CidrRoute
    OperationalMode

    boolean

    當前路由條目是否可操作。

    • true：可操作，表示您可以對當前路由條目執行刪除操作。

    • false：不可操作，表示當前路由條目為系統自動產生，不支援編輯。

    false
    Tag

    string

    路由條目的標籤。

    僅取值：PermitVbr，表示當前路由條目僅會被傳播至轉寄路由器執行個體下 VBR 執行個體的路由表中。

    說明

    僅系統自動產生的轉寄路由器位址區段的路由會返回當前參數。

    PermitVbr
    TransitRouterRouteEntryNextHopResourceId

    string

    路由條目的下一跳執行個體 ID。

    vpc-m5ent6du8deaq5*****
    TransitRouterRouteEntryNextHopResourceType

    string

    路由條目的下一跳執行個體類型。

    • VPC：Virtual Private Cloud（Virtual Private Cloud）執行個體。

    • VBR：邊界路由器 VBR（Virtual Border Router）執行個體。

    • TR：轉寄路由器執行個體。

    • VPN：IPsec 串連執行個體。

    VPC
    TransitRouterRouteEntryOriginResourceType

    string

    路由條目的起源執行個體類型。

    • VPC：Virtual Private Cloud（Virtual Private Cloud）執行個體。

    • VBR：邊界路由器 VBR（Virtual Border Router）執行個體。

    • TR：轉寄路由器執行個體。

    • VPN：IPsec 串連執行個體。

    VPC
    TransitRouterRouteEntryOriginResourceId

    string

    路由條目的起源執行個體 ID。

    vpc-m5ent6du8deaq5*****
    PrefixListId

    string

    首碼列表 ID。

    pl-k1ainl66z3527773d****
    PathAttributes

    object

    路由路徑屬性。

    Communities

    array

    路由條目的 Community 屬性列表。

    string

    路由條目的 Community 屬性值。

    65501:1
    AsPaths

    array

    路由條目的 AS Path 屬性列表。

    string

    路由條目的 AS Path 屬性值。

    65501
    OriginInstanceId

    string

    路由產生的原始執行個體 ID。

    vbr-m5ent6du8deaq5*****

    OriginInstanceType

    string

    路由產生的原始執行個體類型。

    • VPC：Virtual Private Cloud（Virtual Private Cloud）執行個體。

    • VBR：邊界路由器 VBR（Virtual Border Router）執行個體。

    • TR：轉寄路由器執行個體。

    • VPN：IPsec 串連執行個體。

    • CCN：雲串連網（Cloud Connect Network）執行個體。

    VBR
    OriginRouteType

    string

    路由產生時候的路由類型。

    • System：系統路由。

    • Custom：自訂路由。

    • Static：靜態路由。

    • BGP：BGP 路由。

    • BlackHole：黑洞路由。

    BGP
    Preference

    integer

    路由條目的優先順序。

    優先順序數字越小，表示優先順序越高。

    50

    樣本

    正常返回樣本

    JSON格式

    {
  "NextToken": "fce19****",
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount": 6,
  "MaxResults": 20,
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
      "TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
      "TransitRouterRouteEntryType": "Static",
      "CreateTime": "2021-06-15T07:01Z",
      "TransitRouterRouteEntryName": "testname",
      "TransitRouterRouteEntryStatus": "Active",
      "TransitRouterRouteEntryNextHopType": "BlackHole",
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryDescription": "CidrRoute",
      "OperationalMode": false,
      "Tag": "PermitVbr",
      "TransitRouterRouteEntryNextHopResourceId": "vpc-m5ent6du8deaq5*****",
      "TransitRouterRouteEntryNextHopResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceId": "vpc-m5ent6du8deaq5*****",
      "PrefixListId": "pl-k1ainl66z3527773d****",
      "PathAttributes": {
        "Communities": [
          "65501:1"
        ],
        "AsPaths": [
          "65501"
        ],
        "OriginInstanceId": "vbr-m5ent6du8deaq5*****\n",
        "OriginInstanceType": "VBR",
        "OriginRouteType": "BGP",
        "Preference": 50
      }
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalParam.TransitRouterRouteTableId TransitRouterRouteTableId is illegal. 參數中指定的TransitRouterRouteTableId不合法。
    400 IllegalParam.TransitRouterRouteEntryStatus TransitRouterRouteEntryStatus is illegal. 參數中指定的TransitRouterRouteEntryStatus不合法。
    400 IllegalParam.NextToken NextToken is illegal. 參數中指定的NextToken不合法。
    400 ParamExclusive.RouteEntryIdsAndStatus TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive. TransitRouterRouteEntryIds和TransitRouterRouteEntryStatus參數互斥。
    400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found. 轉寄路由器路由表執行個體ID未找到。
    400 FilterKeyDuplicated.RouteFilter The keys in RouteFilter are duplicated. RouteFilter中的key值重複
    400 InvalidFilterKey The key in filter is invalid. The key in filter is invalid.
    400 IllegalParam.TransitRouterRouteEntryNextHopType TransitRouterRouteEntryNextHopType is invalid. TransitRouterRouteEntryNextHopType參數不合法
    400 IllegalParam.TransitRouterRouteEntryNextHopAttachmentId TransitRouterRouteEntryNextHopAttachmentId is invalid. TransitRouterRouteEntryNextHopAttachmentId參數不合法
    400 IllegalParam.TransitRouterRouteEntryNextHopResourceId TransitRouterRouteEntryNextHopResourceId is invalid. TransitRouterRouteEntryNextHopResourceId參數不合法
    400 IllegalParam.TransitRouterRouteEntryNextHopResourceType TransitRouterRouteEntryNextHopResourceType is invalid. TransitRouterRouteEntryNextHopResourceType參數不合法
    400 IllegalParam.TransitRouterRouteEntryOriginResourceId TransitRouterRouteEntryOriginResourceId is invalid. TransitRouterRouteEntryOriginResourceId參數不合法
    400 IllegalParam.TransitRouterRouteEntryOriginResourceType TransitRouterRouteEntryOriginResourceType is invalid. TransitRouterRouteEntryOriginResourceType參數非法
    400 IllegalParam.TransitRouterRouteEntryType TransitRouterRouteEntryType is invalid. TransitRouterRouteEntryType參數不合法
    400 IllegalParam.PrefixExactMatchCidr PrefixExactMatchCidr is invalid. PrefixExactMatchCidr參數不合法
    400 IllegalParam.LongestPrefixMatchCidr LongestPrefixMatchCidr is invalid. LongestPrefixMatchCidr參數不合法
    400 IllegalParam.SubnetOfMatchCidr SubnetOfMatchCidr is invalid. SubnetOfMatchCidr參數不合法
    400 IllegalParam.SupernetOfMatchCidr SupernetOfMatchCidr is invalid. SupernetOfMatchCidr參數不合法
    400 InvalidName Name is invalid. name不合法。
    400 IllegalParam.TextMatchCidr The TextMatchCidr specified in the parameter is illegal. 參數中指定的TextMatchCidr非法。
    400 ResourceNotFound.PrefixlistAssociation The prefix list is not associated with this route table. prefix list未與路由表綁定。
    400 InvalidParameter Invalid parameter. 參數不合法。
    400 Unauthorized The AccessKeyId is unauthorized. 帳號無許可權操作。
    404 InvalidRouteTableId.NotFound The specified RouteTableId is not found. RouteTableId不存在。

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

    變更歷史

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