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

VPN ポリシールートを作成します。

操作説明

開始する前に

ポリシールートを作成する前に、IPsec-VPN 接続が作成されていることを確認してください。詳細については、「 CreateVpnConnection 」を参照してください。
ポリシールートを作成する前に、ポリシールートの使用制限とマッチングルールの理解をお勧めします。詳細については、「ポリシールートの使用」を参照してください。

使用制限

送信先 CIDR ブロックが 0.0.0.0/0 のポリシールートはサポートされていません。
送信先 CIDR ブロックが 100.64.0.0/10、100.64.0.0/10 のサブネット、または 100.64.0.0/10 を含む CIDR ブロックであるポリシールートを追加しないでください。このようなポリシールートを追加すると、コンソールで IPsec-VPN 接続のステータスが表示されなくなったり、IPsec-VPN 接続のネゴシエーションが失敗したりする可能性があります。
CreateVpnPbrRouteEntry 操作は非同期です。この操作を呼び出すと、システムはポリシールートの情報を返しますが、ルートはまだ作成されていません。作成タスクはバックグラウンドで実行中です。 DescribeVpnGateway 操作を呼び出して VPN ゲートウェイのインスタンスステータスをクエリし、ポリシールートの作成ステータスを確認できます。
- VPN ゲートウェイインスタンスが updating 状態の場合、ポリシールートは作成中です。
- VPN ゲートウェイインスタンスが active 状態の場合、ポリシールートは作成済みです。
CreateVpnPbrRouteEntry 操作では、同じ 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:CreateVpnPbrRouteEntry

create

*VpnGateway。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	d7d24a21-f4ba-4454-9173-b3****
VpnGatewayId	string	必須	VPN ゲートウェイインスタンスの ID。	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	必須	ポリシールートのソース CIDR ブロック。	192.168.1.0/24
RouteDest	string	必須	ポリシールートの送信先 CIDR ブロック。	10.0.0.0/24
NextHop	string	必須	ポリシールートのネクストホップ。	vco-bp15oes1py4i66rmd****
Weight	integer	必須	ポリシールートの重み。同じ VPN ゲートウェイインスタンスを使用してアクティブ/スタンバイ IPsec-VPN 接続を確立する場合、ポリシールートの重みを指定してアクティブリンクとスタンバイリンクを設定できます。デフォルトでは、重みが 100 のポリシールートがアクティブリンクとなり、重みが 0 のポリシールートがスタンバイリンクとなります。 IPsec-VPN 接続に対してヘルスチェックを構成し、リンクの接続性を自動的に検出できます。アクティブリンクが利用できない場合、システムは自動的にトラフィックをスタンバイリンクに切り替え、クラウド接続の高可用性を確保します。詳細については、「 CreateVpnConnection 」を参照してください。 100: ポリシールートに関連付けられた IPsec-VPN 接続がアクティブリンクです。 0: ポリシールートに関連付けられた IPsec-VPN 接続がスタンバイリンクです。説明アクティブリンクとスタンバイリンクを指定する場合、アクティブおよびスタンバイのポリシールートのソースおよび送信先 CIDR ブロックは同一である必要があります。デュアルトンネルモードの IPsec-VPN 接続をサポートする VPN ゲートウェイインスタンスの場合、このパラメーターを設定する必要はありません。デュアルトンネルモードの IPsec-VPN 接続には 2 つのトンネルが含まれており、自動的にアクティブ/スタンバイリンクを形成します。このパラメーターを設定してアクティブ/スタンバイリンクを指定する必要はありません。このパラメーターを設定しても、構成は有効になりません。	0
PublishVpc	boolean	必須	ポリシールートを VPC ルートテーブルに公開するかどうかを指定します。有効な値: true: ポリシールートを VPC ルートテーブルに公開します。システムはルートを VPC システムルートテーブルにのみ公開し、VPC カスタムルートテーブルには公開しません。 VPC カスタムルートテーブルにこのルートを含める場合は、手動でルートを追加してください。詳細については、「 CreateRouteEntry 」を参照してください。 false: ポリシールートを VPC ルートテーブルに公開しません。 VPC システムルートテーブルとカスタムルートテーブルの両方に、ネクストホップが VPN ゲートウェイインスタンスを指すポイントを持つポリシールートを手動で追加する必要があります。追加しない場合、VPC は IPsec-VPN 接続経由で CIDR ブロック内のリソースにアクセスできません。	true
Description	string	任意	ポリシールートの説明。説明の長さは 1～100 文字である必要があります。	desctest
OverlayMode	string	任意	トンネリングプロトコル。値を Ipsec (IPsec トンネルプロトコル) に設定します。	Ipsec
Priority	integer	任意	ポリシールートのポリシー優先度。有効な値: 1～100。デフォルト値: 10。値が小さいほど、ポリシールートのポリシー優先度が高くなります。	10
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ルートを作成せずにドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービスの使用制限をチェックします。チェックに失敗した場合、対応するエラーが返されます。チェックに成功した場合、エラーコード `DryRunOperation` が返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。チェックに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
NextHop	string	ポリシールートのネクストホップ。	vco-bp15oes1py4i66rmd****
Weight	integer	ポリシールートの重み。 100: ポリシールートに関連付けられた IPsec-VPN 接続がアクティブリンクです。 0: ポリシールートに関連付けられた IPsec-VPN 接続がスタンバイリンクです。	0
RouteDest	string	ポリシールートの送信先 CIDR ブロック。	10.0.0.0/24
RequestId	string	リクエスト ID。	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	ポリシールートの説明。	desctest
State	string	ポリシールートの公開ステータス。 published: ポリシールートは VPC ルートテーブルに公開されています。 normal: ポリシールートは VPC ルートテーブルに公開されていません。	normal
CreateTime	integer	ポリシールートが作成されたタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX 時間フォーマットに従い、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過ミリ秒数を表します。	1492747187000
OverlayMode	string	トンネリングプロトコル。値を Ipsec (IPsec トンネルプロトコル) に設定します。	Ipsec
RouteSource	string	ポリシールートのソース CIDR ブロック。	192.168.1.0/24
VpnInstanceId	string	VPN ゲートウェイインスタンスの ID。	vpn-bp1cmw7jh1nfe43m9****
Priority	integer	ポリシールートのポリシー優先度。	10

例

成功レスポンス

JSONJSON

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "desctest",
  "State": "normal",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "RouteSource": "192.168.1.0/24",
  "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
  "Priority": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Resource.QuotaFull	The quota of resource is full
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	ルートはすでに存在します。
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	指定されたクライアント IP プールが VPN 接続または SSL サーバーと競合しています。
400	VpnRouteEntry.ConflictSSL	The specified route entry has conflict with SSL client.	ルートエントリが SSL クライアントと競合しています。
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	アクティブ/スタンバイルートエントリの検証が失敗しました。
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	ルートの重み値が無効です。
400	InvalidNextHop.NotFound	The specified NextHop does not exist.	ルートで指定されたネクストホップが存在しません。
400	IllegalParam.RouteDest	The specified RouteDest is invalid	送信先アドレスが無効です。
400	OperationFailed.RouteConflict	Operation failed because there is already a route in VPC route table to another VPN on the same network block.	既存のルートエントリとのルートの競合により、操作が失敗しました。
400	OperationFailed.InvalidCidrBlock	Operation failed because the specified network block is invalid.	CIDR ブロックが無効です。
400	QuotaExceeded.VpnRouteEntry	The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.	VPN ルートエントリの数が上限を超えたため、ルートエントリを作成できませんでした。
400	VpnPbrRouteEntryPriority.NotSupport	Current version of the VPN does not support setting custom pbr route entry priority.	現在のバージョンの VPN ゲートウェイでは、ポリシーベースルートエントリの優先度の設定はサポートされていません。
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	操作が頻繁すぎます。しばらく待ってからもう一度お試しください。
400	VpnTask.CONFLICT	Vpn task has conflict.	VPN 操作の競合が存在します。後でもう一度お試しください。
400	VpnGateway.Configuring	The specified service is configuring.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	VpnRouteEntry.SrcDestWeightConflict	The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight.	VPN ゲートウェイでは、ソース CIDR ブロック、送信先 CIDR ブロック、および重みが同一のポリシーベースルートを設定することはサポートされていません。
400	VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap	The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap.	VPN ゲートウェイでは、ソースおよび送信先 CIDR ブロックが重複する、同じ優先度を持つ複数のポリシーベースルートを設定することはサポートされていません。
400	VpnRouteEntry.SrcDestConflict	The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR.	デュアルトンネル VPN ゲートウェイでは、ソースおよび送信先 CIDR ブロックが同一のポリシーベースルートを設定することはサポートされていません。
400	CreatePbrRoutesQuotaFull.QuotaFull	The number of policy routes exceeds the quota limit.	ポリシーベースルートの数がクォータ制限を超えています。
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun 検証が有効です。
400	VpnPbrRouteEntry.NotSupport	Current version of the VPN does not support pbr route entry.	現在の 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 を操作する権限があるかどうかを確認してください。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

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

変更履歴

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