IPsec 接続のルートをクエリします。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
IPsec 接続のリージョン ID です。 最新のリージョン一覧を取得するには、DescribeRegions 操作を呼び出してください。 |
cn-hangzhou |
| VpnConnectionId |
string |
必須 |
IPsec 接続の ID です。 |
vco-p0w2jpkhi2eeop6q6**** |
| RouteEntryType |
string |
任意 |
ルートタイプです。有効値は次のとおりです。
|
custom |
| PageNumber |
integer |
任意 |
返されるページ番号です。デフォルト値は 1 です。 |
1 |
| PageSize |
integer |
任意 |
各ページに返されるエントリー数です。デフォルト値は 10 です。有効値は 1 ～ 50 です。 |
10 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。 クライアント側で値を生成できますが、すべてのリクエストの中で一意であることを保証する必要があります。ClientToken には ASCII 文字のみを使用できます。 説明
このパラメーターを設定しない場合、システムは RequestId を ClientToken として使用します。RequestId の値は、各 API リクエストごとに異なる可能性があります。 |
123e4567-e89b-12d3-a456-4266**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| TotalCount |
integer |
返されたエントリー数です。 |
1 |
| PageNumber |
integer |
返されたページ番号です。 |
1 |
| PageSize |
integer |
各ページに返されるエントリー数です。 |
10 |
| VcoRouteEntries |
array<object> |
ルートエントリーのリストです。 |
|
|
object |
ルートに関する情報です。 |
||
| VpnConnectionId |
string |
IPsec 接続の ID です。 |
vco-p0w2jpkhi2eeop6q6**** |
| RouteDest |
string |
ルートの宛先 CIDR ブロックです。 |
192.168.10.0/24 |
| NextHop |
string |
ルートのネクストホップです。 |
vco-p0w2jpkhi2eeop6q6**** |
| Weight |
integer |
宛先ベースルートの重みです。 説明
現在、このパラメーターは効果がありません。 |
100 |
| State |
string |
ルートのステータスです。
|
published |
| RouteEntryType |
string |
ルートタイプです。有効値は次のとおりです。
|
custom |
| CreateTime |
integer |
ルートが作成されたタイムスタンプです。 この値は UNIX タイムスタンプで、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。 |
1658217008000 |
| AsPath |
string |
BGP ルートが通過する自律システム (AS) 番号のリストです。 |
[12000] |
| Community |
string |
BGP ルートに含まれるコミュニティ値です。 |
65535:65510 |
| Source |
string |
BGP ルートのソースです。有効値は次のとおりです。
|
CLOUD |
| NextHopTunnelIdList |
array |
ネクストホップのリストです。 説明
|
|
|
string |
トンネル ID です。 |
tun-0jothw962cp3bvhbw**** |
|
| RequestId |
string |
リクエスト ID です。 |
E18980E8-C8C2-31BD-8156-AE2BBDEC87E1 |
| VpnRouteCounts |
array<object> |
デュアルトンネル IPsec 接続のルートエントリーに関する情報です。 説明
このパラメーターは、デュアルトンネルモードの IPsec 接続の場合にのみ返されます。 |
|
|
object |
ルートエントリーに関する情報です。 |
||
| RouteEntryType |
string |
ルートタイプです。有効値は次のとおりです。
|
bgp |
| RouteCount |
integer |
ルートエントリー数です。 |
3 |
| Source |
string |
BGP ルートのソースです。有効値は次のとおりです。
|
VPN_BGP |
例
成功レスポンス
JSONJSON
{
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"VcoRouteEntries": [
{
"VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
"RouteDest": "192.168.10.0/24",
"NextHop": "vco-p0w2jpkhi2eeop6q6****",
"Weight": 100,
"State": "published",
"RouteEntryType": "custom",
"CreateTime": 1658217008000,
"AsPath": "[12000]",
"Community": "65535:65510",
"Source": "CLOUD",
"NextHopTunnelIdList": [
"tun-0jothw962cp3bvhbw****"
]
}
],
"RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
"VpnRouteCounts": [
{
"RouteEntryType": "bgp",
"RouteCount": 3,
"Source": "VPN_BGP"
}
]
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.RouteEntryType | The specified RouteEntryType is invalid. | |
| 400 | Vco.StatusNotSupport | The current VPN connection state does not support this operation. | |
| 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 | InvalidVpnConnectionInstanceId.NotFound | The specified vpn connection instance id does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。