VPN ゲートウェイインスタンスの送信先ルートを作成します。送信先ルートの作成後、VPN ゲートウェイインスタンスはトラフィックの送信先 IP アドレスに基づいて送信先ルートをマッチングし、マッチした送信先ルートに基づいてトラフィックを転送します。
操作説明
事前準備
送信先ルートを作成する前に、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 接続のネゴシエーションが失敗したりする可能性があります。
- CreateVpnRouteEntry 操作は非同期です。リクエストを送信すると、システムは送信先ルーティング構成を返しますが、送信先ルートはまだ作成されていません。作成ノードはバックグラウンドで実行中です。 DescribeVpnGateway を呼び出して、送信先ルートの作成ステータスをクエリできます。
VPN ゲートウェイインスタンスが updating 状態の場合、送信先ルートは作成中です。
VPN ゲートウェイインスタンスが active 状態の場合、送信先ルートは作成済みです。
CreateVpnRouteEntry 操作では、同じ VPN ゲートウェイに対する送信先ルートの同時作成はサポートされていません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vpc:CreateVpnRouteEntry |
create |
*VpnGateway
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 」を参照してください。
説明
|
0 |
| PublishVpc |
boolean |
必須 |
送信先ルートを VPC ルートテーブルに公開するかどうかを指定します。有効な値:
|
true |
| Description |
string |
任意 |
送信先ルートの説明。 説明の長さは 1 ～ 100 文字で、 |
mytest |
| OverlayMode |
string |
任意 |
トンネリングプロトコル。値を Ipsec (IPsec トンネルプロトコル) に設定します。 |
Ipsec |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効な値:
|
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| NextHop |
string |
送信先ルートのネクストホップ。 |
vco-bp15oes1py4i66rmd**** |
| Weight |
integer |
送信先ルートの重み。有効な値:
|
0 |
| RouteDest |
string |
送信先ルートの送信先 CIDR ブロック。 |
10.0.0.0/24 |
| RequestId |
string |
リクエスト ID。 |
5BE01CD7-5A50-472D-AC14-CA181C5C03BE |
| Description |
string |
送信先ルートの説明。 |
mytest |
| State |
string |
送信先ルートの公開ステータス。
|
published |
| 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": "published",
"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. | 指定されたクライアント 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 | TaskConflict | The operation is too frequent, please wait a moment and try again. | 操作が頻繁すぎます。しばらく待ってからもう一度お試しください。 |
| 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. | EIP が現在の呼び出し元に属していません。この EIP を呼び出す権限があるかどうかを確認してください。 |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。