CENインスタンスに接続されているトランジットルーターを照会します。

使用上の注意

要件に基づいて、RegionIdパラメーターとTransitRouterIdパラメーターを設定できます。

  • RegionIdまたはTransitRouterIdを設定しない場合、システムは指定されたCENインスタンスに接続されているすべてのトランジットルーターを照会します。
  • RegionIdのみを設定した場合、システムは指定されたリージョンにデプロイされているトランジットルーターを照会します。
  • TransitRouterIdのみを設定した場合、システムは指定されたトランジットルーターを照会します。
  • RegionIdとTransitRouterIdの両方を設定した場合、システムは指定されたリージョンの指定されたトランジットルーターを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 ListTransitRouters

実行する操作です。 値をListTransitRoutersに設定します。

PageNumber Integer 任意 1

返されるページのページ番号。 既定値：1

PageSize Integer 任意 10

各ページで返されるエントリ数。 有効な値: 1〜50。 デフォルト値: 10

CenId String 必須 cen-j3jzhw1zpau2km ****

CEN インスタンスの ID。

TransitRouterId String 任意 tr-uf654ttymmljlvh2x ****

トランジットルーターのID。

RegionId String 任意 cn-qingdao

トランジットルーターがデプロイされているリージョンのID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

レスポンスパラメーター

パラメーター データ型 例 説明
PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 68521297-5FA6-46CB-B4EB-658F1C68C8CC

リクエストの ID です。

PageNumber Integer 1

返されたページの数を示します。

TotalCount Integer 2

返されたエントリの数。

TransitRouters TransitRouterの配列

トランジットルーターのリスト。

CreationTime String 2021-03-15T09:39Z

トランジットルーターが作成された時刻。

時間はYYYY-MM-DDThh:mmZ形式のISO8601標準に従います。 時刻は UTC で表示されます。

データ型 String エンタープライズ

トランジットルーターのエディション。 設定可能な値は以下のとおりです。

  • Enterprise: Enhance Edition
  • 基本: 基本版
Status String Active

トランジットルーターのステータス。 設定可能な値は以下のとおりです。

  • 作成中: トランジットルーターが作成中です。
  • Active: トランジットルーターが利用可能です。
  • 変更中: トランジットルーターは変更中です
  • Deleting: トランジットルーターは削除中です。
  • Upgrading: トランジットルーターのアップグレード中です。
TransitRouterId String tr-bp1su1ytdxtataupl****

トランジットルーターのID。

TransitRouterDescription String testdesc

トランジットルーターの説明。

TransitRouterName String テスト名

トランジットルーターの名前。

CenId String cen-j3jzhw1zpau2km ****

CEN インスタンスの ID。

AliUid Long 253460731706911258

CENインスタンスが属するAlibaba CloudアカウントのID。

RegionId String cn-qingdao

トランジットルーターがデプロイされているリージョンのID。

SupportMulticast ブール 偽

トランジットルーターでマルチキャストが有効になっているかどうかを示します。 設定可能な値は以下のとおりです。

  • true: 有効
  • false: 無効

例

リクエストの例

http(s)://[Endpoint]/?Action=ListTransitRouters
&PageNumber=1
&PageSize=10
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-uf654ttymmljlvh2x****
&RegionId=cn-qingdao
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRoutersResponse>
    <TotalCount> 2 </ TotalCount>
    <RequestId>68521297-5FA6-46CB-B4EB-658F1C68C8CC</RequestId>
    <のPageSize> 10 </がPageSize>
    <ページ番号> 1 </ PAGENUMBER>
    <TransitRouters>
        <Status>Active</Status>
        <タイプ> エンタープライズ </タイプ>
        <CenId>cen-j3jzhw1zpau2km ****</CenId>
        <CreationTime>2021-03-15T09:39Z</CreationTime>
        <TransitRouterName>zxtest</TransitRouterName>
        <RegionId>cn-hangzhou</RegionId>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
        <AliUid>253460731706911258</AliUid>
    </TransitRouters>
    <TransitRouters>
        <Status>Active</Status>
        <タイプ> 基本 </タイプ>
        <CenId>cen-j3jzhw1zpau2km ****</CenId>
        <CreationTime>2021-03-22T02:11Z</CreationTime>
        <RegionId>cn-qingdao</RegionId>
        <TransitRouterId>tr-m5eq27g6bndum7e88 ****</TransitRouterId>
        <AliUid>253460731706911258</AliUid>
    </TransitRouters>
</ListTransitRoutersResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "RequestId" : "68521297-5FA6-46CB-B4EB-658F1C68C8CC" 、
  "PageSize" : 10,
  "PageNumber" : 1,
  "TransitRouters" : [ {
    "ステータス" : "アクティブ" 、
    "タイプ" : "エンタープライズ" 、
    "CenId" : "cen-j3jzhw1zpau2km ****" 、
    "CreationTime" : "2021-03-15T09:39Z" 、
    "TransitRouterName" : "zxtest" 、
    "RegionId" : "cn-hangzhou" 、
    "TransitRouterId" : "tr-bp1su1ytdxtataupl ****" 、
    "AliUid" : "253460731706911258"
  }, {
    "ステータス" : "アクティブ" 、
    "タイプ" : "基本" 、
    "CenId" : "cen-j3jzhw1zpau2km ****" 、
    "CreationTime" : "2021-03-22T02:11Z" 、
    "RegionId" : "cn-qingdao" 、
    "TransitRouterId" : "tr-m5eq27g6bndum7e88 ****" 、
    "AliUid" : "253460731706911258"
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。