ListTransitRouters查詢轉寄路由器-雲企業網-阿里雲

調用ListTransitRouters介面查詢雲企業網執行個體下轉寄路由器執行個體的執行個體類型、執行個體的狀態、轉寄路由器執行個體ID、是否開啟了組播功能等資訊。

介面說明

在您調用本介面查詢雲企業網執行個體下轉寄路由器執行個體的資訊時，您可以按需填寫參數 RegionId 和 TransitRouterId，關於這兩個參數的關係，請參見以下說明：

如果您未輸入 RegionId 和 TransitRouterId 的值，則表示您要查詢雲企業網執行個體下所有轉寄路由器執行個體的資訊。
如果您只輸入了 RegionId 的值，則表示您要查詢雲企業網執行個體指定地區下的轉寄路由器執行個體的資訊。
如果您只輸入了 TransitRouterId 的值，則表示您要查詢雲企業網執行個體中指定的轉寄路由器執行個體的資訊。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListTransitRouters

get

CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*TransitRouter

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

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁顯示的條目數。取值範圍：1~50。預設值：10。	10
CenId	string	否	雲企業網執行個體 ID。	cen-j3jzhw1zpau2km****
TransitRouterId	string	否	轉寄路由器執行個體 ID。	tr-uf654ttymmljlvh2x****
RegionId	string	否	轉寄路由器執行個體所屬地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
Tag	array<object>	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
	object	否	標籤資訊。
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能以`aliyun`或者`acs:`開頭，不能包含`http://`或者`https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	TagKey
Value	string	否	資源的標籤值。標籤值可以為空白或輸入不超過 128 個字元的字串，不能以`aliyun`或者`acs:`開頭，不能包含`http://`或者`https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue
Status	string	否	轉寄路由器執行個體的狀態。 Creating：建立中。 Active：可用。 Modifying：修改中。 Deleting：刪除中。 Upgrading：升級中。	Active
Type	string	否	轉寄路由器執行個體的類型。 Enterprise：企業版。 Basic：基礎版。	Enterprise
TransitRouterName	string	否	轉寄路由器執行個體的名稱。名稱長度為 1~128 個字元不能以`http://`或`https://`開頭。	testname
FeatureFilter	array<object>	否	轉寄路由器功能篩選欄位。
	object	否	轉寄路由器功能篩選欄位。
Key	string	否	轉寄路由器功能篩選欄位索引值。目前支援欄位： Multicast：組播功能。	Multicast
Value	array	否	轉寄路由器功能篩選欄位值列表。當索引值為 Multicast 時，只支援填入 1 個欄位，支援欄位內容為： Enabled：支援組播。 Disabled：不支援組播。
	string	否	轉寄路由器功能篩選欄位值。當索引值為 Multicast 時支援欄位為： Enabled：支援組播。 Disabled：不支援組播。	Enabled

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
PageSize	integer	分頁查詢時每頁顯示的條目數。	10
RequestId	string	請求 ID。	68521297-5FA6-46CB-B4EB-658F1C68C8CC
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	1
TransitRouters	array<object>	轉寄路由器執行個體資訊列表。
	object	轉寄路由器執行個體的資訊。
CreationTime	string	轉寄路由器執行個體的建立時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mmZ`。	2021-03-15T09:39Z
Type	string	轉寄路由器執行個體的類型。 Enterprise：企業版。 Basic：基礎版。	Enterprise
Status	string	轉寄路由器執行個體的狀態。 Creating：建立中。 Active：可用。 Modifying：修改中。 Deleting：刪除中。 Upgrading：升級中。	Active
TransitRouterId	string	轉寄路由器執行個體 ID。	tr-bp1su1ytdxtataupl****
TransitRouterDescription	string	轉寄路由器執行個體的描述資訊。	testdesc
TransitRouterName	string	轉寄路由器執行個體的名稱。	testname
CenId	string	雲企業網執行個體 ID。	cen-j3jzhw1zpau2km****
AliUid	integer	雲企業網執行個體所屬阿里雲帳號（主帳號）ID。	1210123456123456
RegionId	string	轉寄路由器執行個體所屬地區 ID。	cn-hangzhou
SupportMulticast	boolean	轉寄路由器執行個體是否開啟了組播功能。 true：已開啟。 false：未開啟。	false
TransitRouterCidrList	array<object>	轉寄路由器位址區段列表。
	object	轉寄路由器位址區段。
Cidr	string	轉寄路由器位址區段。	192.168.1.0/24
Name	string	轉寄路由器位址區段的名稱。	CIDRname
Description	string	轉寄路由器位址區段的描述資訊。	CIDRdesc
TransitRouterCidrId	string	轉寄路由器位址區段 ID。	cidr-46p5ceg21e8152****
PublishCidrRoute	boolean	是否允許系統自動在轉寄路由器路由表中添加轉寄路由器位址區段的路由。 true：允許。如果當前參數傳回值為 true，則在您建立了私網網關類型的 VPN 串連，並為私網網關類型的 VPN 串連建立了路由學習關係後，系統自動在與 VPN 串連建立路由學習關係的轉寄路由器路由表中添加一條路由條目：目標網段為轉寄路由器位址區段的黑洞路由，其中轉寄路由器位址區段指已為 IPsec 串連分配網關 IP 位址的位址區段。該黑洞路由僅會被傳播至轉寄路由器下 VBR 執行個體的路由表中。 false：不允許。	true
Tags	array<object>	標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
  "PageNumber": 1,
  "TotalCount": 1,
  "TransitRouters": [
    {
      "CreationTime": "2021-03-15T09:39Z",
      "Type": "Enterprise",
      "Status": "Active",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "TransitRouterDescription": "testdesc",
      "TransitRouterName": "testname",
      "CenId": "cen-j3jzhw1zpau2km****",
      "AliUid": 1210123456123456,
      "RegionId": "cn-hangzhou",
      "SupportMulticast": false,
      "TransitRouterCidrList": [
        {
          "Cidr": "192.168.1.0/24",
          "Name": "CIDRname",
          "Description": "CIDRdesc",
          "TransitRouterCidrId": "cidr-46p5ceg21e8152****",
          "PublishCidrRoute": true
        }
      ],
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameterCombination.TransitRouter	Region ID is required if no TransitRouterId or CenId specified.	至少需要傳入Region，TransitRouterId 或CenId三者中的一個。
400	InvalidOperation.UnsupportFilterValue	The specified FeatureFilter Value is not supported by this operation.	參數中指定的FeatureFilter Value不合法。
400	InvalidOperation.UnsupportFilter	The specified FeatureFilter is not supported by this operation.	參數中指定的FeatureFilter不合法。
400	IllegalParam.TagValue	The tag values are not valid.	參數中指定的tag value不合法。
400	IllegalParam.TagKey	The tag keys are not valid.	參數中指定的tag key不合法。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無許可權操作。

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

變更歷史

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