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

VPN ゲートウェイインスタンスの送信先ルートを作成します。送信先ルートの作成後、VPN ゲートウェイインスタンスはトラフィックの送信先 IP アドレスに基づいて送信先ルートをマッチングし、マッチングした送信先ルートに基づいてトラフィックを転送します。

操作説明

事前準備

送信先ルートを作成する前に、IPsec-VPN 接続が作成されていることを確認してください。詳しくは、「 CreateVpnConnection 」を参照してください。
送信先ルートを作成する前に、送信先ルートのマッチングルールの理解を推奨します。詳しくは、「送信先ルートの設定」を参照してください。

使用制限

送信先ルートの送信先 CIDR ブロックとして 0.0.0.0/0 はサポートされていません。
シングルトンネル VPN ゲートウェイの場合、送信先ルートの送信先 CIDR ブロックとして 100.64.0.0/10 と重複する CIDR ブロック (100.64.0.0/10 自体、そのサブネット、およびそれを含む親 CIDR ブロックを含む) はサポートされていません。
CreateVpnRouteEntry 操作は非同期です。リクエストを送信した後、システムは送信先ルートの構成を返しますが、送信先ルートはまだ作成されていません。作成タスクは引き続きバックグラウンドで実行中です。 DescribeVpnGateway を呼び出して、送信先ルートの作成ステータスをクエリできます。
- VPN ゲートウェイインスタンスが updating 状態の場合、送信先ルートは作成中です。
- VPN ゲートウェイインスタンスがアクティブな (active) 状態の場合、送信先ルートは作成されています。
CreateVpnRouteEntry 操作は、同じ 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:CreateVpnRouteEntry

create

*VpnGateway。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイインスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストの呼び出しのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API リクエストごとに異なる場合があります。	d7d24a21-f4ba-4454-9173-b3828dae****
VpnGatewayId	string	必須	VPN ゲートウェイのインスタンス ID。	vpn-bp1a3kqjiiq9legfx****
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 文字までで、`http://` または `https://` で始めることはできません。	mytest
OverlayMode	string	任意	トンネリングプロトコル。値を Ipsec (IPsec トンネリングプロトコル) に設定します。	Ipsec
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランを実行するかどうかを指定します。有効な値: true: ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービス制限などの潜在的な問題についてリクエストをチェックします。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス要素。
NextHop	string	送信先ルートのネクストホップ。	vco-bp15oes1py4i66rmd****
Weight	integer	送信先ルートの重み。有効な値: 100: 送信先ルートの優先度が高いことを示します。 0: 送信先ルートの優先度が低いことを示します。	0
RouteDest	string	送信先ルートの送信先 CIDR ブロック。	10.0.0.0/24
RequestId	string	リクエスト ID。	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	送信先ルートの説明。	mytest
State	string	送信先ルートの公開ステータス。 published: 送信先ルートが VPC ルートテーブルに公開されています。 normal: 送信先ルートは VPC ルートテーブルに公開されていません。	公開
CreateTime	integer	送信先ルートが作成されたタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX 時間フォーマットに従い、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から送信先ルートが作成された時刻までに経過したミリ秒の総数を表します。	1492747187000
OverlayMode	string	トンネリングプロトコル。値を Ipsec (IPsec トンネリングプロトコル) に設定します。	Ipsec
VpnInstanceId	string	VPN ゲートウェイのインスタンス ID。	vpn-bp1a3kqjiiq9legfx****

例

成功レスポンス

JSONJSON

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "mytest",
  "State": "公開",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Resource.QuotaFull	The quota of resource is full
400	VpnGateway.Configuring	The specified service is configuring.
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.	ルートエントリの競合が存在します。
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.	VPC ルートテーブルに、同じ CIDR ブロックに対して別の VPN ゲートウェイをポイントするルートが既に存在します。
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.	VPC ルートテーブル内の VPN ゲートウェイを指すルートエントリ数がクォータ制限に達しました。
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	EIP に対する操作が頻繁すぎます。
400	VpnTask.CONFLICT	Vpn task has conflict.	VPN 操作の競合が発生しました。後でもう一度お試しください。
400	IncorrectVpcStatus	Current VPC status does not support this operation.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun チェックに合格しました。
400	CreatePbrRoutesQuotaFull.QuotaFull	The number of policy routes exceeds the quota limit.	ポリシーベースルートの数がクォータ制限を超えています。
400	CreateDbrRoutesQuotaFull.QuotaFull	The number of created destination routes exceeds the quota limit.	送信先ルートの数がクォータ制限を超えています。
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.	指定されたリソースを操作する権限がありません。必要な権限を申請してから、もう一度お試しください。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

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

変更履歴

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