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

Virtual Private Cloud:ListGatewayRouteTableEntries

最終更新日:Jun 26, 2026

ListGatewayRouteTableEntries 操作を呼び出して、ゲートウェイルートテーブルのルートエントリを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:ListGatewayRouteTableEntries

list

*RouteTable

acs:vpc:{#regionId}:{#accountId}:routetable/{#routetableId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

クエリするゲートウェイルートテーブルのリージョン ID。

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

ap-southeast-6

MaxResults

integer

任意

ページングクエリの 1 ページあたりのエントリ数。有効な値: 1100。デフォルト値: 10

10

NextToken

string

任意

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

  • 最初のリクエストの場合、または後続のクエリが存在しない場合は、このパラメーターを指定する必要はありません。

  • 次のクエリが存在する場合は、前回の API 呼び出しで返された NextToken の値を設定します。

FFmyTO70tTpLG6I3FmYAXGKPd****

GatewayRouteTableId

string

必須

クエリするゲートウェイルートテーブルの ID。

vtb-5ts0ohchwkp3dydt2****

DestinationCidrBlock

string

任意

クエリするゲートウェイルートテーブル内のルートエントリの送信先 CIDR ブロック。

192.168.0.5

RegionId

string

必須

クエリするゲートウェイルートテーブルのリージョン ID。

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

ap-southeast-6

レスポンスフィールド

フィールド

説明

object

ゲートウェイルートテーブル情報。

NextToken

string

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

  • NextToken が空の場合、次のクエリは存在しません。

  • NextToken が返された場合、その値は次のクエリのトークンを示します。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

リクエスト ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

TotalCount

string

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

1

GatewayRouteEntryModels

array<object>

ゲートウェイルートテーブル内のルートエントリの詳細。

array<object>

ゲートウェイルートテーブル内のルートエントリの詳細。

Status

string

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

  • Pending: 設定中。

  • Available: 利用可能。

  • Modifying: 変更中。

Available

NextHopId

string

ネクストホップのインスタンス ID。

i-bp11gcl0sm85t9bi****

Description

string

ルートエントリの説明。

test

NextHopType

string

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

  • EcsInstance: ECS インスタンス。

  • NetworkInterface: Elastic ネットワークインターフェイスコントローラー (NIC)。

  • Local: ローカル。

EcsInstance

DestinationCidrBlock

string

ルートエントリの送信先 CIDR ブロック。

192.168.0.5

Name

string

ルートエントリの名前。

名前は 2 ~ 128 文字で、英字または中国語の文字で始まる必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。

name

NextHops

array<object>

ネクストホップ情報。

object

NextHopId

string

ネクストホップのインスタンスID。

vpn-bp10zyaph5cc8b7c7****

NextHopType

string

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

  • Instance(デフォルト):ECSインスタンス。

  • HaVip:高可用性仮想 IPアドレス(HaVip)。

  • VpnGateway:VPNゲートウェイ。

  • NatGateway:NATゲートウェイ。

  • NetworkInterface:セカンダリElastic Network Interface(ENI)。

  • RouterInterface:vRouterインターフェース。

  • IPv6Gateway:IPv6ゲートウェイ。

  • Attachment:トランジットルーター。

Instance

Weight

string

ルートエントリの重み。

100

Enabled

string

ルートが使用可能かどうかを示します。有効な値:

  • 0:使用不可。

  • 1:使用可能。

1

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "TotalCount": "1",
  "GatewayRouteEntryModels": [
    {
      "Status": "Available",
      "NextHopId": "i-bp11gcl0sm85t9bi****",
      "Description": "test",
      "NextHopType": "EcsInstance",
      "DestinationCidrBlock": "192.168.0.5",
      "Name": "name",
      "NextHops": [
        {
          "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
          "NextHopType": "Instance",
          "Weight": "100",
          "Enabled": "1"
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ResourceNotFound.GatewayRouteTable The specified resource GatewayRouteTable is not found.
400 IllegalParam.NextToken The param of nextToken is illegal

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

変更履歴

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