すべてのプロダクト
Search

このプロダクト

    Cloud Enterprise Network:ListTransitRouters

    ドキュメントセンター

    Cloud Enterprise Network:ListTransitRouters

    最終更新日:Aug 07, 2025

    ListTransitRouters 操作を呼び出して、Cloud Enterprise Network (CEN) インスタンス内のトランジットルーターに関する情報 (インスタンスタイプ、ステータス、インスタンス ID、マルチキャスト機能が有効かどうかなど) をクエリできます。

    操作説明

    この操作を呼び出して CEN インスタンス内のトランジットルーターをクエリする場合、[RegionId] パラメーターと [TransitRouterId] パラメーターを指定できます。 これらのパラメーターに関する以下の情報に注意してください。

    • [RegionId] または [TransitRouterId] を指定しない場合、CEN インスタンス内のすべてのトランジットルーターがクエリされます。

    • [RegionId] のみ指定した場合、指定したリージョン内のトランジットルーターがクエリされます。

    • [TransitRouterId] のみ指定した場合、指定したトランジットルーターがクエリされます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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 ページあたりのエントリ数。 有効な値: [1] から [50]。 デフォルト値: [10]。

    10
    CenId

    string

    任意

    CEN インスタンスの ID。

    cen-j3jzhw1zpau2km****
    TransitRouterId

    string

    任意

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

    tr-uf654ttymmljlvh2x****
    RegionId

    string

    任意

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

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

    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]: Enterprise Edition。

    • [Basic]: Basic Edition。

    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

    1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    68521297-5FA6-46CB-B4EB-658F1C68C8CC
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されたエントリの総数。

    1
    TransitRouters

    array<object>

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

    object

    トランジットルーターに関する情報。

    CreationTime

    string

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

    時刻は UTC の YYYY-MM-DDThh:mmZ 形式で表示されます。

    2021-03-15T09:39Z
    Type

    string

    トランジットルーターのタイプ。

    • [Enterprise]: Enterprise Edition。

    • [Basic]: Basic Edition。

    Enterprise
    Status

    string

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

    • [Creating]: トランジットルーターを作成中です。

    • [Active]: トランジットルーターは使用可能です。

    • [Modifying]: トランジットルーターを変更中です。

    • [Deleting]: トランジットルーターを削除中です。

    • [Upgrading]: トランジットルーターをアップグレード中です。

    Active
    TransitRouterId

    string

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

    tr-bp1su1ytdxtataupl****
    TransitRouterDescription

    string

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

    testdesc
    TransitRouterName

    string

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

    testname
    CenId

    string

    CEN インスタンスの ID。

    cen-j3jzhw1zpau2km****
    AliUid

    integer

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

    1210123456123456
    RegionId

    string

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

    cn-hangzhou
    SupportMulticast

    boolean

    トランジットルーターでマルチキャスト機能が有効になっているかどうかを示します。

    • [true]: 有効。

    • [false]: 無効。

    false
    TransitRouterCidrList

    array<object>

    トランジットルーターの CIDR ブロックのリスト。

    object

    トランジットルーターの CIDR ブロック。

    Cidr

    string

    トランジットルーターの CIDR ブロック。

    192.168.1.0/24
    Name

    string

    CIDR ブロックの名前。

    CIDRname
    Description

    string

    CIDR ブロックの説明。

    CIDRdesc
    TransitRouterCidrId

    string

    CIDR ブロックの ID。

    cidr-46p5ceg21e8152****
    PublishCidrRoute

    boolean

    システムがトランジットルーター CIDR ブロックのルートをトランジットルーターのルートテーブルに自動的に追加するかどうかを示します。

    • [true]: はい。

      このパラメーターが [true] に設定されている場合、プライベートゲートウェイタイプの VPN 接続を作成し、VPN 接続のルート学習を有効にすると、システムは VPN 接続とルート学習の相関関係にあるトランジットルーターのルートテーブルにブラックホールルートを自動的に追加します。

      ブラックホールルートの宛先 CIDR ブロックは、トランジットルーターの CIDR ブロックです。 トランジットルーターの CIDR ブロックは、IPsec-VPN 接続に IP アドレスが割り当てられる CIDR ブロックです。

      このブラックホールルートは、トランジットルーターに接続されている仮想ボーダールーター (VBR) のルートテーブルにのみアドバタイズされます。

    • [false]: いいえ。

    true
    Tags

    array<object>

    タグのリスト。

    object

    タグ。

    Key

    string

    タグキー。

    TagKey
    Value

    string

    タグ値。

    TagValue

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameterCombination.TransitRouter Region ID is required if no TransitRouterId or CenId specified.
    400 InvalidOperation.UnsupportFilterValue The specified FeatureFilter Value is not supported by this operation.
    400 InvalidOperation.UnsupportFilter The specified FeatureFilter is not supported by this operation.
    400 IllegalParam.TagValue The tag values are not valid.
    400 IllegalParam.TagKey The tag keys are not valid.
    400 InvalidParameter Invalid parameter.
    400 Unauthorized The AccessKeyId is unauthorized.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。