すべてのプロダクト
Search

このプロダクト

    Cloud Enterprise Network:ListTransitRouterRouteEntries

    ドキュメントセンター

    Cloud Enterprise Network:ListTransitRouterRouteEntries

    最終更新日:Aug 07, 2025

    エンタープライズ版トランジットルーターのルートテーブルにあるルートの詳細をクエリします。

    今すぐお試しください

    この 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:ListTransitRouterRouteEntries

    get

    TransitRouterRouteEntry

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

    TransitRouterRouteTable

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

    TransitRouterRouteEntry

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    MaxResults

    integer

    任意

    1 ページあたりのエントリ数。有効な値： 1 ～ 100 。デフォルト値： 20 。

    20
    TransitRouterRouteEntryDestinationCidrBlock deprecated

    string

    任意

    ルートの宛先 CIDR ブロック。このパラメーターは廃止予定です。 RouteFilter パラメーターを使用することをお勧めします。

    192.168.0.0/24
    TransitRouterRouteEntryStatus

    string

    任意

    ルートのステータス。有効な値：

    • All

    • Active （デフォルト）

    • Rejected

    • Prohibited

    • Standby

    • Candidate

    値を指定しない場合、アクティブ状態のルートがクエリされます。

    Active
    TransitRouterRouteTableId

    string

    必須

    エンタープライズ版トランジットルーターのルートテーブルの ID 。

    vtb-bp1dudbh2d5na6b50****
    NextToken

    string

    任意

    次のリクエストで使用されるページネーショントークンで、新しい結果ページを取得するために使用されます。有効な値：

    • 最初のリクエストでは、このパラメーターを指定する必要はありません。

    • 前のクエリから取得したトークンを 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

    • VBR

    • TR

    • VPN

    VPC
    TransitRouterRouteEntryOriginResourceId

    string

    任意

    ソースインスタンス ID です。

    vpc-m5ent6du8deaq5*****
    TransitRouterRouteEntryOriginResourceType

    string

    任意

    ソースインスタンスタイプ。有効な値：

    • VPC

    • VBR

    • TR

    • VPN

    VPC
    PrefixListId

    string

    任意

    プレフィックスリスト ID です。

    pl-6ehtn5kqxgeyy08fi****
    RouteFilter

    array<object>

    任意

    フィルター条件。

    object

    任意

    フィルター条件。

    Key

    string

    任意

    CIDR ブロックをフィルタリングするための一致パターン。有効な値:

    • PrefixExactMatchCidrs: 完全一致。

    • LongestPrefixMatchCidrs: 最長プレフィックス一致。 IP アドレスと CIDR ブロックを指定できます。

    • SubnetOfMatchCidrs: サブネット一致。指定された CIDR ブロックのサブネット (CIDR ブロック自体を含む) が一致条件と照合されます。

    • SupernetOfMatchCidrs: スーパーネット一致。 CIDR ブロックのスーパーネット (CIDR ブロック自体を含む) が一致条件と照合されます。

    デフォルトでは、フィルター条件間の論理演算子は AND です。ルートエントリがすべてのフィルター条件に一致する場合にのみ、ルートエントリに関する情報が返されます。フィルター条件は一意である必要があります。

    PrefixExactMatchCidrs
    Value

    array

    任意

    フィルター値。

    string

    任意

    キー に基づいてフィルター値を指定します。 1 つの キー に複数の値を指定できます。 値間の論理演算子は OR です。これは、リクエストが値のいずれかと一致する場合、ルートエントリが一致することを示します。 一致条件ごとに最大 500 個の値を指定できます。
    IPv4 アドレスと CIDR ブロック、および IPv6 アドレスと CIDR ブロックがサポートされています。

    192.168.1.0/24

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    応答パラメーター。

    NextToken

    string

    ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。有効な値：

    • NextToken が空の場合、次のページは存在しません。

    • NextToken に値が返された場合、その値は次のクエリの開始点を決定するトークンです。

    fce19****
    RequestId

    string

    リクエスト ID。

    C3835E5E-1504-4344-B1BB-98A4110F1079
    TotalCount

    integer

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

    6
    MaxResults

    integer

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

    20
    TransitRouterRouteEntries

    array<object>

    ルートエントリのリスト。

    object

    ルートに関する情報。

    TransitRouterRouteEntryId

    string

    ルート ID。

    説明

    このパラメーターは、静的ルートの場合にのみ返されます。

    rte-oklkgwmj97z6dn****
    TransitRouterRouteEntryDestinationCidrBlock

    string

    ルートエントリの宛先 CIDR ブロック。 IPv4 または IPv6 CIDR ブロックが返されます。

    192.168.0.0/24
    TransitRouterRouteEntryType

    string

    ルートのタイプ。有効な値：

    • スタティック: スタティックルート。

    • 伝搬: ルートテーブルによって自動的に学習されます。

    Static
    CreateTime

    string

    ルートエントリが作成された時刻。

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

    説明

    このパラメーターは、静的ルートの場合にのみ返されます。

    2021-06-15T07:01Z
    TransitRouterRouteEntryName

    string

    ルート名。

    説明

    このパラメーターは、静的ルートの場合にのみ返されます。

    testname
    TransitRouterRouteEntryStatus

    string

    ルートステータス。有効な値：

    • アクティブ

    • 注意: プラグインをインストールする前に、必ず互換性などを確認してください。

    • 禁止

    • スタンバイ

    • 候補

    • 作成

    • 削除

    Active
    TransitRouterRouteEntryNextHopType

    string

    ネクストホップタイプ。有効な値：

    • ヒント: インストールプロセスを簡素化するために、WordPress の自動インストーラーを使用できます。

    • 接続先: ネットワークインスタンス接続。ルートの宛先 CIDR ブロック宛てのパケットは、指定されたネットワークインスタンス接続に転送されます。

    BlackHole
    TransitRouterRouteEntryNextHopId

    string

    ネクストホップ ID。ルートがブラックホールルートの場合、このパラメーターは返されません。

    tr-attach-vx6iwhjr1x1j78****
    TransitRouterRouteEntryDescription

    string

    ルートの説明。

    説明

    このパラメーターは、静的ルートの場合にのみ返されます。

    CidrRoute
    OperationalMode

    boolean

    ルートを管理できるかどうかを示します。有効な値：

    • Note: Some plugins may require additional configuration after installation.

    • false: ルートはシステムによって自動的に生成されるため、管理できません。

    false
    Tag

    string

    ルートタグ。

    PermitVbr のみが返される可能性があります。これは、ルートが、トランジットルーターに接続されている仮想境界ルーター（VBR）のルートテーブルにのみアドバタイズされることを示します。

    説明

    このパラメーターは、CIDR ブロックがシステムによって自動的に生成されるルートの場合にのみ返されます。

    PermitVbr
    TransitRouterRouteEntryNextHopResourceId

    string

    ネクストホップ ID。

    vpc-m5ent6du8deaq5*****
    TransitRouterRouteEntryNextHopResourceType

    string

    ネクストホップタイプ。有効な値：

    • VPC

    • VBR

    • TR

    • VPN

    VPC
    TransitRouterRouteEntryOriginResourceType

    string

    ソースインスタンスタイプ。有効な値：

    • VPC

    • VBR

    • TR

    • VPN

    VPC
    TransitRouterRouteEntryOriginResourceId

    string

    ソースインスタンス ID です。

    vpc-m5ent6du8deaq5*****
    PrefixListId

    string

    プレフィックスリスト ID です。

    pl-k1ainl66z3527773d****
    PathAttributes

    object

    ルート属性。

    Communities

    array

    ルートコミュニティ。

    string

    ルートのコミュニティ属性。

    65501:1
    AsPaths

    array

    ルート AS パス。

    string

    ルートの AS パス。

    65501
    OriginInstanceId

    string

    ソースインスタンス ID です。

    vbr-m5ent6du8deaq5*****

    OriginInstanceType

    string

    ソースインスタンスタイプ。有効な値：

    • VPC

    • VBR

    • TR

    • VPN

    • CCN

    VBR
    OriginRouteType

    string

    ルートタイプ。有効な値：

    • システム

    • カスタム

    • スタティック

    • BGP

    • ブラックホール

    BGP
    Preference

    integer

    ルートの優先度。

    値が小さいほど、優先度が高くなります。

    50

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.TransitRouterRouteTableId TransitRouterRouteTableId is illegal.
    400 IllegalParam.TransitRouterRouteEntryStatus TransitRouterRouteEntryStatus is illegal.
    400 IllegalParam.NextToken NextToken is illegal.
    400 ParamExclusive.RouteEntryIdsAndStatus TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive.
    400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found.
    400 FilterKeyDuplicated.RouteFilter The keys in RouteFilter are duplicated.
    400 InvalidFilterKey The key in filter is invalid.
    400 IllegalParam.TransitRouterRouteEntryNextHopType TransitRouterRouteEntryNextHopType is invalid.
    400 IllegalParam.TransitRouterRouteEntryNextHopAttachmentId TransitRouterRouteEntryNextHopAttachmentId is invalid.
    400 IllegalParam.TransitRouterRouteEntryNextHopResourceId TransitRouterRouteEntryNextHopResourceId is invalid.
    400 IllegalParam.TransitRouterRouteEntryNextHopResourceType TransitRouterRouteEntryNextHopResourceType is invalid.
    400 IllegalParam.TransitRouterRouteEntryOriginResourceId TransitRouterRouteEntryOriginResourceId is invalid.
    400 IllegalParam.TransitRouterRouteEntryOriginResourceType TransitRouterRouteEntryOriginResourceType is invalid.
    400 IllegalParam.TransitRouterRouteEntryType TransitRouterRouteEntryType is invalid.
    400 IllegalParam.PrefixExactMatchCidr PrefixExactMatchCidr is invalid.
    400 IllegalParam.LongestPrefixMatchCidr LongestPrefixMatchCidr is invalid.
    400 IllegalParam.SubnetOfMatchCidr SubnetOfMatchCidr is invalid.
    400 IllegalParam.SupernetOfMatchCidr SupernetOfMatchCidr is invalid.
    400 InvalidName Name is invalid.
    400 IllegalParam.TextMatchCidr The TextMatchCidr specified in the parameter is illegal.
    400 ResourceNotFound.PrefixlistAssociation The prefix list is not associated with this route table.
    400 InvalidParameter Invalid parameter.
    400 Unauthorized The AccessKeyId is unauthorized.
    404 InvalidRouteTableId.NotFound The specified RouteTableId is not found.

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

    変更履歴

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