全部產品
Search
文件中心

:DescribeTransitRouteTableAggregation - 查詢企業版轉寄路由器路由表下的彙總路由

更新時間:Aug 07, 2025

查詢企業版轉寄路由器路由表下的彙總路由。

介面說明

您可以通過指定 TransitRouteTableId 參數和 TransitRouteTableAggregationCidr 參數的值,查詢指定彙總路由的資訊。如果您僅指定了 TransitRouteTableId 參數的值,則系統預設查詢該企業版轉寄路由器路由表下所有彙總路由的資訊。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:DescribeTransitRouteTableAggregation

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

TransitRouteTableId

string

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

vtb-6ehgc262hr170qgyc****

TransitRouteTableAggregationCidr

string

彙總路由的目標網段。

192.168.10.0/24

ClientToken

string

用戶端 Token,用於保證請求的等冪性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

02fb3da4-130e-11e9-8e44-001****

MaxResults

integer

分批次查詢時每次顯示的條目數。預設值:20

20

NextToken

string

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

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

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

FFmyTO70tTpLG6I3FmYAXGKPd****

返回參數

名稱

類型

描述

樣本值

object

返回結果。

Data

array<object>

彙總路由資訊列表。

object

彙總路由資訊。

Name

string

彙總路由的名稱。

nametest

TransitRouteTableAggregationCidr

string

彙總路由的目標網段。

192.168.10.0/24

Scope

string

彙總路由的傳播範圍。

僅取值:VPC,表示向已與當前企業版轉寄路由器路由表建立關聯轉寄關係並已開啟路由同步功能的所有 VPC 執行個體傳播彙總路由。

VPC

RouteType

string

彙總路由的路由類型。

僅取值:Static,表示靜態路由。彙總路由被傳播至 VPC 執行個體後,預設為自訂路由條目。

Static

Description

string

彙總路由的描述資訊。

desctest

TrRouteTableId

string

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

vtb-6ehgc262hr170qgyc****

Status

string

彙總路由的傳播狀態。

  • AllConfigured:彙總路由已下發至全部 VPC 執行個體。

  • Configuring:彙總路由下發中。

  • ConfigFailed:彙總路由下發失敗。

  • PartialConfigured:部分 VPC 沒有被成功下發彙總路由。

  • Deleting:彙總路由刪除中。

AllConfigured

ScopeList

array

彙總路由的傳播範圍列表。

說明

彙總路由傳播範圍和彙總路由傳播範圍列表必須至少選擇一個屬性,建議使用彙總路由傳播範圍列表;彙總路由傳播範圍列表中元素不能與彙總路由傳播範圍的值重複。

string

彙總路由的傳播範圍列表。 取值:

  • VPC,表示向已與當前企業版轉寄路由器路由表建立關聯轉寄關係並已開啟路由同步功能的所有 VPC 執行個體傳播彙總路由。

  • VBR,表示向已載入到當前企業版轉寄路由器的 VBR 執行個體傳播彙總路由。

  • Peer,表示向已與當前企業版轉寄路由器建立了跨地區串連的轉寄路由器傳播彙總路由。

  • VPN,表示向已載入到當前企業版轉寄路由器的 VPN 執行個體傳播彙總路由。

  • ECR,表示向已載入到當前企業版轉寄路由器的 ECR 執行個體傳播彙總路由。

VPC

Count

integer

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

20

NextToken

string

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

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

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

FFmyTO70tTpLG6I3FmYAXGKPd****

Total

integer

列表條目數。

1

RequestId

string

請求 ID。

0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

樣本

正常返回樣本

JSON格式

{
  "Data": [
    {
      "Name": "nametest",
      "TransitRouteTableAggregationCidr": "192.168.10.0/24",
      "Scope": "VPC",
      "RouteType": "Static",
      "Description": "desctest",
      "TrRouteTableId": "vtb-6ehgc262hr170qgyc****",
      "Status": "AllConfigured",
      "ScopeList": [
        "VPC"
      ]
    }
  ],
  "Count": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "Total": 1,
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 MissingParam.transitRouterRouteTableId Missing the parameter transitRouter route table id. 缺少參數transitRouterRouteTableId。
400 IllegalParam.NextToken The nextToken is illegal. 參數中指定的NextToken不合法。
400 InstanceNotExist.TransitRouterRouteTable The transitRouter route table is not found. 未找到該企業版轉寄路由器路由表。
400 InvalidCidrBlock The transitRouteTableAggregationCidr is invalid. 參數TransitRouteTableAggregationCidr無效。
400 InvalidParameter Invalid parameter. 參數不合法。
400 Unauthorized The AccessKeyId is unauthorized. 帳號無許可權操作。

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

變更歷史

更多資訊,參考變更詳情