VPN ゲートウェイの送信先ルートを作成します。送信先ルートの作成後、VPN ゲートウェイはトラフィックの送信先 IP アドレスに基づいて送信先ルートを照合し、照合された送信先ルートに基づいてトラフィックを転送します。
操作説明
開始する前に
送信先ルートを作成する前に、IPsec-VPN 接続を作成済みであることを確認してください。詳細については、「 CreateVpnConnection 」を参照してください。
送信先ルートを作成する前に、送信先ルートの照合ルールについて理解しておくことを推奨します。詳細については、「送信先ルートの設定」を参照してください。
使用制限
送信先ルートの送信先 CIDR ブロックとして 0.0.0.0/0 はサポートされていません。
シングルトンネル VPN ゲートウェイの場合、100.64.0.0/10 と重複する CIDR ブロック (CIDR ブロック自体、そのサブネット、およびスーパーネットを含む) は、送信先ルートの送信先 CIDR ブロックとしてサポートされていません。
- CreateVpnRouteEntry 操作は非同期です。システムは送信先ルートの構成情報を返しますが、送信先ルートはまだ作成されていません。作成タスクは引き続きバックグラウンドで実行中です。 DescribeVpnGateway 操作を呼び出して、送信先ルートの作成ステータスをクエリできます。
VPN ゲートウェイが updating 状態の場合、送信先ルートは作成中です。
VPN ゲートウェイが アクティブな 状態の場合、送信先ルートは作成済みです。
CreateVpnRouteEntry 操作では、同じ VPN ゲートウェイでの送信先ルートの同時作成はサポートされていません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
VPN ゲートウェイのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。 |
cn-hangzhou |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。 説明
このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は一意です。 |
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. | ルートエントリの競合が存在します。 |
| 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. | 指定されたプレフィックスリスト内の CIDR ブロックが、IPsec-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. | ドライランチェックに合格しました。 |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。