DescribeVpnRouteEntries - VPN Gateway - Alibaba Cloud ドキュメントセンター

VPN ゲートウェイインスタンスの送信先ルートおよび BGP ルート情報を照会します。

今すぐお試しください

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

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、リージョン ID を照会できます。	cn-hangzhou
VpnGatewayId	string	必須	VPN ゲートウェイインスタンスの ID。	vpn-bp1cmw7jh1nfe43m9****
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
RouteEntryType	string	任意	ルートエントリのタイプ。有効な値: custom (デフォルト): VPN ゲートウェイインスタンスの送信先ルート。 bgp: VPN ゲートウェイインスタンスの BGP ルート。	custom

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5
PageNumber	integer	リストのページ番号。	1
TotalCount	integer	リスト内のエントリの総数。	1
VpnRouteEntries	object
VpnRouteEntry	array<object>	ルートエントリのリスト。
	object	ルートエントリの詳細。
RouteEntryType	string	ルートエントリのタイプです。有効な値は次のとおりです。 Custom：カスタム System：システム	custom
NextHop	string	ルートエントリのネクストホップです。	vco-bp1tui07ob10fmuro****
Weight	integer	ルートエントリの重みです。有効な値は 0 および 100 です。 0：低優先度 100：高優先度	100
RouteDest	string	ルートエントリの宛先 CIDR ブロックです。	10.0.0.0/24
AsPath	string	ルートエントリの AS パスです。	65501,65001,60011
State	string	ルートエントリのステータスです。有効な値は次のとおりです。 published：公開済み normal：未公開	normal
CreateTime	integer	ルートエントリが作成されたタイムスタンプです。	1563874074000
Community	string	ルートエントリのコミュニティ属性です。	65001:1000,65501:2000
Source	string	BGP ルートのソースです。有効な値は次のとおりです。 CLOUD：VPN ゲートウェイに関連付けられたクラウドサービスからアドバタイズされたルートです。 VPN_BGP：現在のルートが VPN ゲートウェイの BGP を使用して学習されたことを示します。たとえば、オンプレミスデータセンターのルートを BGP で学習します。	CLOUD
VpnInstanceId	string	VPN ゲートウェイの ID です。	vpn-bp1cmw7jh1nfe43m9****
NextHopTunnelId	string	ネクストホップに関連付けられたトンネルの ID です。説明このパラメーターは、VPN ゲートウェイがデュアルトンネルモードをサポートしている場合にのみ返されます。	tun-36cfgpwjn58axj****
VpnRouteCounts	object
VpnRouteCount	array<object>	デュアルトンネルモードにおける VPN ゲートウェイインスタンスのルート統計情報。説明この情報は、デュアルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイインスタンスに対してのみ返されます。
	object	ルートの統計情報。
RouteEntryType	string	ルートタイプです。有効な値は次のとおりです。 custom（デフォルト）：宛先ベースルート bgp：BGP ルートエントリ	bgp
RouteCount	integer	ルートエントリの数です。	3
Source	string	BGP ルートのソースです。有効な値は次のとおりです。 CLOUD：VPN ゲートウェイに関連付けられたクラウドサービスからアドバタイズされたルートです。 VPN_BGP：現在のルートが VPN ゲートウェイの BGP を使用して学習されたことを示します。たとえば、オンプレミスデータセンターのルートを BGP で学習します。	VPN_BGP

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnRouteEntries": {
    "VpnRouteEntry": [
      {
        "RouteEntryType": "custom",
        "NextHop": "vco-bp1tui07ob10fmuro****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "AsPath": "65501,65001,60011",
        "State": "normal",
        "CreateTime": 1563874074000,
        "Community": "65001:1000,65501:2000",
        "Source": "CLOUD",
        "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
        "NextHopTunnelId": "tun-36cfgpwjn58axj****"
      }
    ]
  },
  "VpnRouteCounts": {
    "VpnRouteCount": [
      {
        "RouteEntryType": "bgp",
        "RouteCount": 3,
        "Source": "VPN_BGP"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.RouteEntryType	The specified "RouteEntryType" is invalid.
400	InvalidVpnInstanceId.NotFound	The specified VPN was not found.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.

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

変更履歴

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