すべてのプロダクト
Search
ドキュメントセンター

:ListTransitRouterRouteEntries

最終更新日:Feb 21, 2025

Enterprise Editionトランジットルーターのルートテーブル内のルートエントリを照会します。

デバッグ

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

リクエストパラメーター

パラメーターデータ型必須/任意説明
操作String任意ListTransitRouterRouteEntries

実行したい操作。 値をListTransitRouterRouteEntriesに設定します。

TransitRouterRouteTableIdString必須vtb-bp1dudbh2d5na6b50 ****

Enterprise EditionトランジットルーターのルートテーブルのID。

MaxResultsInteger任意4

返される各ページのエントリ数。 有効な値: 1001ます。 デフォルト値: 20

TransitRouterRouteEntryDestinationCidrBlockString任意192.168.0.0/24

ルートエントリのターゲット CIDR ブロック。

TransitRouterRouteEntryStatusString任意Active

ルートエントリのステータス。 有効な値: 有効な値:

  • Creating: ルートエントリが作成中です。
  • Active: ルートエントリがアクティブです。
  • Deleting: ルートエントリは削除中です。
TransitRouterRouteEntryNames.NRepeatList任意testname

ルートエントリの名前。

名前は1 ~ 128文字で、英数字、および次の特殊文字を使用できます。 ; / @ _ -. 名前を空のままにすることもできます。

各呼び出しで複数のルートエントリを照会できます。 Nの最大値: 20

説明 この操作では、静的ルートのみを照会します。
TransitRouterRouteEntryIds.NRepeatList任意rte-oklkgwmj97z6dn ****

ルートエントリのID。

各呼び出しで複数のルートエントリを照会できます。 Nの最大値: 20

説明 この操作では、静的ルートのみを照会します。
NextTokenString任意fce19 ****

複数のページでデータが返された場合に次のページを返すためのトークン。

レスポンスパラメーター

パラメーターデータ型説明
MaxResultsInteger4

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

NextTokenStringfce19 ****

複数のページでデータが返された場合に次のページを返すためのトークン。

RequestIdStringC3835E5E-1504-4344-B1BB-98A4110F1079

リクエストの ID です。

TotalCountInteger6

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

TransitRouterRouteEntriesTransitRouterRouteEntryの配列

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

CreateTimeString2021-06-15T07:01Z

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

時間はyyyy-MM-ddThh:mm:ssZ形式のISO 8601標準に従います。 時刻は UTC 表示です。

説明 このパラメーターは、静的ルートに対してのみ返されます。
TransitRouterRouteEntryDescriptionStringtestdesc

ルートエントリの説明。

説明 このパラメーターは、静的ルートに対してのみ返されます。
TransitRouterRouteEntryDestinationCidrBlockString172.16.0.0/16

ルートエントリのターゲット CIDR ブロック。

TransitRouterRouteEntryIdStringrte-oklkgwmj97z6dn ****

ルートエントリのID。

説明 このパラメーターは、静的ルートに対してのみ返されます。
TransitRouterRouteEntryNameStringtest

ルートエントリの名前。

説明 このパラメーターは、静的ルートに対してのみ返されます。
TransitRouterRouteEntryNextHopIdStringtr-attach-vx6iwhjr1x1j78****

次のホップのID。

TransitRouterRouteEntryNextHopTypeStringブラックホール

次のホップのタイプ。 設定可能な値は以下のとおりです。

  • BlackHole: nullインターフェイス。 ルートエントリの宛先CIDRブロック宛てのパケットはドロップされます。
  • 添付ファイル: ネットワークインスタンス接続。 ルートエントリの宛先CIDRブロック宛てのパケットは、指定されたネットワークインスタンス接続に転送されます。
TransitRouterRouteEntryStatusStringActive

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

  • Creating: ルートエントリが作成中です。
  • Active: ルートエントリがアクティブです。
  • Deleting: ルートエントリは削除中です。
TransitRouterRouteEntryTypeString伝播

ルートエントリのタイプ。 設定可能な値は以下のとおりです。

  • Static: 静的ルート
  • Propagated: an automatically learned route

リクエストの例

http(s)://[Endpoint]/?Action=ListTransitRouterRouteEntries
&TransitRouterRouteTableId=vtb-bp1dudbh2d5na6b50 ****
&<共通リクエストパラメーター>

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

XML 形式

<ListTransitRouterRouteEntriesResponse> 
  <TotalCount>6</TotalCount>
  <NextToken>fce19 ****</NextToken>
  <RequestId>C3835E5E-1504-4344-B1BB-98A4110F1079</RequestId>
  <MaxResults>4</MaxResults>
  <TransitRouterRouteEntries>
        <TransitRouterRouteEntryDestinationCidrBlock>10.0.1.0/24</TransitRouterRouteEntryDestinationCidrBlock>
        <TransitRouterRouteEntryNextHopId>tr-attach-vx6iwhjr1x1j78 ****</TransitRouterRouteEntryNextHopId>
        <TransitRouterRouteEntryType> 伝播 </TransitRouterRouteEntryType>
        <TransitRouterRouteEntryNextHopType> 添付ファイル </TransitRouterRouteEntryNextHopType>
        <TransitRouterRouteEntryStatus> アクティブ </TransitRouterRouteEntryStatus>
  </TransitRouterRouteEntries>
  <TransitRouterRouteEntries>
        <TransitRouterRouteEntryDestinationCidrBlock>10.0.137.40/29</TransitRouterRouteEntryDestinationCidrBlock>
        <TransitRouterRouteEntryNextHopId>tr-attach-vx6iwhjr1x1j78****</TransitRouterRouteEntryNextHopId>
        <TransitRouterRouteEntryType> 伝播 </TransitRouterRouteEntryType>
        <TransitRouterRouteEntryNextHopType> 添付ファイル </TransitRouterRouteEntryNextHopType>
        <TransitRouterRouteEntryStatus> アクティブ </TransitRouterRouteEntryStatus>
  </TransitRouterRouteEntries>
  <TransitRouterRouteEntries>
        <TransitRouterRouteEntryDestinationCidrBlock>10.0.2.0/24</TransitRouterRouteEntryDestinationCidrBlock>
        <TransitRouterRouteEntryNextHopId>tr-attach-vx6iwhjr1x1j78 ****</TransitRouterRouteEntryNextHopId>
        <TransitRouterRouteEntryType> 伝播 </TransitRouterRouteEntryType>
        <TransitRouterRouteEntryNextHopType> 添付ファイル </TransitRouterRouteEntryNextHopType>
        <TransitRouterRouteEntryStatus> アクティブ </TransitRouterRouteEntryStatus>
  </TransitRouterRouteEntries>
  <TransitRouterRouteEntries>
        <TransitRouterRouteEntryDestinationCidrBlock>172.16.0.0/16</TransitRouterRouteEntryDestinationCidrBlock>
        <TransitRouterRouteEntryNextHopId></TransitRouterRouteEntryNextHopId>
        <TransitRouterRouteEntryType> 静的 </TransitRouterRouteEntryType>
        <CreateTime>2021-06-15T07:01Z</CreateTime>
        <TransitRouterRouteEntryNextHopType> ブラックホール </TransitRouterRouteEntryNextHopType>
        <TransitRouterRouteEntryName> テスト </TransitRouterRouteEntryName>
        <TransitRouterRouteEntryId>rte-oklkgwmj97z6dn ****</TransitRouterRouteEntryId>
        <TransitRouterRouteEntryStatus> アクティブ </TransitRouterRouteEntryStatus>
  </TransitRouterRouteEntries>
</ListTransitRouterRouteEntriesResponse>

JSON 形式

{
  "TotalCount": 6,
  "NextToken": "fce19 ****" 、
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079" 、
  "MaxResults": 4、
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryDestinationCidrBlock": "10.0.1.0/24" 、
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78 ****" 、
      "TransitRouterRouteEntryType": "伝播" 、
      "TransitRouterRouteEntryNextHopType": "アタッチメント" 、
      "TransitRouterRouteEntryStatus": "Active"
    },
    {
      "TransitRouterRouteEntryDestinationCidrBlock": "10.0.137.40/29" 、
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78 ****" 、
      "TransitRouterRouteEntryType": "伝播" 、
      "TransitRouterRouteEntryNextHopType": "アタッチメント" 、
      "TransitRouterRouteEntryStatus": "Active"
    },
    {
      "TransitRouterRouteEntryDestinationCidrBlock": "10.0.2.0/24" 、
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryType": "伝播" 、
      "TransitRouterRouteEntryNextHopType": "アタッチメント" 、
      "TransitRouterRouteEntryStatus": "Active"
    },
    {
      "TransitRouterRouteEntryDestinationCidrBlock": "172.16.0.0/16" 、
      "TransitRouterRouteEntryNextHopId": "",
      "TransitRouterRouteEntryType": "静的" 、
      "CreateTime": "2021-06-15T07:01Z" 、
      "TransitRouterRouteEntryNextHopType": "BlackHole" 、
      "TransitRouterRouteEntryName": "test" 、
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn ****" 、
      "TransitRouterRouteEntryStatus": "Active"
    }
  ]
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
400InvalidTransitRouterRouteTableId.NotFoundTransitRouterRouteTableIdが見つかりません。指定されたトランジットルーターのルートテーブルIDが存在しない場合に返されるエラーメッセージ。

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