VPN ゲートウェイに設定されたポリシールーティングをクエリします。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
VPN ゲートウェイが配置されているリージョン ID です。 最新のリージョン一覧は、DescribeRegions 操作を呼び出して確認できます。 |
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 ゲートウェイの場合、ポリシールーティングの重みはルートの優先度を示します。
説明
シングルトンネルモードで IPsec 接続をサポートしない VPN ゲートウェイでは、このパラメーターは効果がありません。 |
100 |
| RouteDest |
string |
ポリシールーティングの宛先 CIDR ブロックです。 |
10.0.0.0/24 |
| State |
string |
ポリシールーティングのステータスです。有効値：
|
published |
| CreateTime |
integer |
ポリシールーティングの作成時刻です。単位：ミリ秒。 この値は UNIX タイムスタンプで、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1492747187000 |
| VpnInstanceId |
string |
VPN ゲートウェイの ID です。 |
vpn-bp1a3kqjiiq9legfx**** |
| RouteSource |
string |
ポリシールーティングの送信元 CIDR ブロックです。 |
192.168.0.0/24 |
| Priority |
integer |
ポリシールーティングの優先度です。 値が小さいほど、優先度が高くなります。 |
10 |
| NextHopTunnelId |
string |
ポリシールーティングのネクストホップに関連付けられたトンネルの ID です。 このパラメーターは、VPN ゲートウェイがデュアルトンネルモードで IPsec 接続をサポートしている場合にのみ返されます。 |
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": "published",
"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. | |
| 400 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。