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

IPsec-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:DescribeVcoRouteEntries

list

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	IPsec-VPN 接続のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
VpnConnectionId	string	必須	IPsec-VPN 接続の ID。	vco-p0w2jpkhi2eeop6q6****
RouteEntryType	string	任意	ルートのタイプ。有効な値: custom (デフォルト): 送信先ルート。 bgp: BGP ルート。	custom
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 10。有効な値: 1 ～ 50。	10
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API 呼び出しごとに異なる場合があります。	123e4567-e89b-12d3-a456-4266****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
TotalCount	integer	返されたエントリの総数。	1
PageNumber	integer	リストのページ番号。	1
PageSize	integer	ページングクエリの 1 ページあたりのエントリ数。	10
VcoRouteEntries	array<object>	ルートのリスト。
	object	ルート情報。
VpnConnectionId	string	IPsec-VPN 接続の ID。	vco-p0w2jpkhi2eeop6q6****
RouteDest	string	ルートの送信先 CIDR ブロック。	192.168.10.0/24
NextHop	string	ルートのネクストホップ。	vco-p0w2jpkhi2eeop6q6****
Weight	integer	送信先ルートの重み。説明このパラメーターは使用されていません。	100
State	string	ルートのステータス。 published: 送信先ルートがトランジットルーターインスタンスに公開されています。 Active: BGP ルートが利用可能です。	公開
RouteEntryType	string	ルートのタイプ。 custom: ルートは送信先ルートです。 bgp: ルートは BGP ルートです。	custom
CreateTime	integer	送信先ルートが作成されたタイムスタンプ。タイムスタンプは UNIX フォーマットで、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。	1658217008000
AsPath	string	BGP ルートが通過する自律システム (AS) 番号のリスト。	[12000]
Community	string	BGP ルートが保持するコミュニティ値。	65535:65510
Source	string	BGP ルートのソース。 CLOUD: BGP ルートは IPsec-VPN 接続がトランジットルーターから学習したものです。 VPN_BGP: BGP ルートは IPsec-VPN 接続がオンプレミスデータセンターから学習したものです。	CLOUD
NextHopTunnelIdList	array	ネクストホップトンネルのリスト。説明この情報は、デュアルトンネルモードの IPsec-VPN 接続に対してのみ返されます。トンネル情報は、トンネルステータスが Phase 2 negotiations succeeded の場合にのみ返されます。
	string	トンネル ID。	tun-0jothw962cp3bvhbw****
RequestId	string	リクエスト ID。	E18980E8-C8C2-31BD-8156-AE2BBDEC87E1
VpnRouteCounts	array<object>	デュアルトンネルモードの IPsec-VPN 接続のルート統計情報。説明この情報は、デュアルトンネルモードの IPsec-VPN 接続に対してのみ返されます。
	object	ルート統計情報。
RouteEntryType	string	ルートのタイプ。 custom: 送信先ルート。 bgp: BGP ルート。	bgp
RouteCount	integer	ルートの数。	3
Source	string	BGP ルートのソース。 CLOUD: BGP ルートは IPsec-VPN 接続がトランジットルーターから学習したものです。 VPN_BGP: BGP ルートは IPsec-VPN 接続がオンプレミスデータセンターから学習したものです。	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.	RouteEntryType パラメーターが無効です。
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	現在の VPN カスタマーゲートウェイのステータスでは、変更や削除などの操作はサポートされていません。
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	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	指定された VPN 接続が存在しません。VPN 接続 ID が正しいかどうかを確認してください。

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

変更履歴

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