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

VPN ゲートウェイインスタンスに設定されたポリシーベースルートを照会します。

今すぐお試しください

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

get

*VpnGateway。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	eu-central-1
VpnGatewayId	string	必須	VPN ゲートウェイのインスタンス ID。	vpn-bp1a3kqjiiq9legfx****
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
PageNumber	integer	リストのページ番号。	1
TotalCount	integer	リストのエントリの総数。	1
VpnPbrRouteEntries	object
VpnPbrRouteEntry	array<object>	ポリシーベースルートのリスト。
	object	ポリシーベースルートの情報。
NextHop	string	ポリシーベースルートのネクストホップ。	vco-bp15oes1py4i66rmd****
Weight	integer	ポリシーベースルートの重み。シングルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイインスタンスの場合、重みの値はポリシーベースルートの優先度を示します。 100: 高優先度。同じソースおよび送信先 CIDR ブロックを持つ複数のポリシーベースルートが存在する場合、このポリシーベースルートに関連付けられた IPsec-VPN 接続がアクティブなリンクとして機能します。 0: 低優先度。同じソースおよび送信先 CIDR ブロックを持つ複数のポリシーベースルートが存在する場合、このポリシーベースルートに関連付けられた IPsec-VPN 接続がスタンバイリンクとして機能します。説明デュアルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイインスタンスの場合、このパラメーターは効果がありません。	100
RouteDest	string	ポリシーベースルートの送信先 CIDR ブロック。	10.0.0.0/24
State	string	ポリシーベースルートの公開ステータス。 published: ポリシーベースルートは VPC のルートテーブルに公開されています。 normal: ポリシーベースルートは VPC のルートテーブルに公開されていません。	公開
CreateTime	integer	ポリシーベースルートが作成されたタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX フォーマットで、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過ミリ秒数を示します。	1492747187000
VpnInstanceId	string	VPN ゲートウェイインスタンスの ID。	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	ポリシーベースルートのソース CIDR ブロック。	192.168.0.0/24
Priority	integer	ポリシーベースルートのポリシー優先度。値が小さいほど優先度が高くなります。	10
NextHopTunnelId	string	ポリシーベースルートのネクストホップに関連付けられたトンネル ID。このパラメーターは、デュアルトンネル IPsec-VPN 接続をサポートする VPN ゲートウェイインスタンスに対してのみ返されます。	tun-opsqc4d97wni2****

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnPbrRouteEntries": {
    "VpnPbrRouteEntry": [
      {
        "NextHop": "vco-bp15oes1py4i66rmd****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "State": "公開",
        "CreateTime": 1492747187000,
        "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****",
        "RouteSource": "192.168.0.0/24",
        "Priority": 10,
        "NextHopTunnelId": "tun-opsqc4d97wni2****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidVpnInstanceId.NotFound	The specified VPN was not found.	指定された VPN インスタンスが見つかりませんでした。
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	指定された VPN ゲートウェイが存在しません。VPN ゲートウェイが正しいかどうかを確認してください。
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.	EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。

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

変更履歴

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