DescribeVpnAttachments - 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:DescribeVpnAttachments

list

*VpnConnections

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	IPsec-VPN 接続のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページング時の 1 ページあたりのエントリ数。デフォルト値: 10。有効な値: 1 ～ 50。	10
VpnConnectionId	string	任意	IPsec-VPN 接続の ID。説明 IPsec-VPN 接続 ID を指定しない場合、システムは現在のリージョンでトランジットルーターインスタンスに関連付けられているすべての IPsec-VPN 接続を照会します。	vco-p0w2jpkhi2eeop6q6****
AttachType	string	任意	IPsec-VPN 接続がアタッチされているリソースのタイプ。デフォルト値: CEN。値は CEN のみ指定可能で、システムがトランジットルーターインスタンスに関連付けられた IPsec-VPN 接続を照会することを示します。	CEN

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	9F0725BB-186A-3564-91C3-AAE48042F853
PageSize	integer	ページング時の 1 ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	1
VpnAttachments	array<object>	トランジットルーターインスタンスに関連付けられた IPsec-VPN 接続のリスト。
	array<object>	トランジットルーターインスタンスに関連付けられた IPsec-VPN 接続の情報。
InstanceId	string	IPsec-VPN 接続の ID。	vco-p0w2jpkhi2eeop6q6****
Name	string	IPsec-VPN 接続の名前。	nametest1
Description	string	IPsec-VPN 接続の説明。	desctest
AttachType	string	IPsec-VPN 接続がアタッチされているリソースのタイプ。値は CEN で、IPsec-VPN 接続がトランジットルーターインスタンスに関連付けられていることを示します。	CEN
TransitRouterId	string	IPsec-VPN 接続がアタッチされている転送ルーティング vRouter のインスタンス ID。	tr-p0wkh4yryb1dnanqw****
TransitRouterName	string	トランジットルーターインスタンスの名前。	nametest2
CrossAccountAuthorized	boolean	IPsec-VPN 接続が、異なる Alibaba Cloud アカウントに属するトランジットルーターインスタンスに関連付けられているかどうかを示します。 true: IPsec-VPN 接続はクロスアカウントのトランジットルーターインスタンスに関連付けられています。 false: IPsec-VPN 接続はクロスアカウントのトランジットルーターインスタンスに関連付けられていません。	false
Tag	string	IPsec-VPN 接続のシステムタグ。システムタグを使用して、IPsec-VPN 接続が BGP をサポートしているかどうかを確認できます。他のプロパティは無視できます。 BGPSupport: IPsec-VPN 接続が BGP をサポートしているかどうかを示します。 true: サポートされています。 false: サポートされていません。	{\"description\":\"転送1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}
Tags	array<object>	IPsec-VPN 接続に関連付けられたタグのリスト。
	object	タグ情報。
Key	string	タグキー。	TagKey
Value	string	タグ値。	TagValue
TunnelBandwidth	string	単一 VPN トンネルの帯域幅仕様。有効な値: Standard (デフォルト): 標準。デフォルト帯域幅は 1 Gbit/s です。 Large: Large。デフォルト帯域幅は 3 Gbit/s です。	標準

例

成功レスポンス

JSONJSON

{
  "RequestId": "9F0725BB-186A-3564-91C3-AAE48042F853",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnAttachments": [
    {
      "InstanceId": "vco-p0w2jpkhi2eeop6q6****",
      "Name": "nametest1",
      "Description": "desctest",
      "AttachType": "CEN",
      "TransitRouterId": "tr-p0wkh4yryb1dnanqw****",
      "TransitRouterName": "nametest2",
      "CrossAccountAuthorized": false,
      "Tag": "{\\\"description\\\":\\\"forwarding1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TunnelBandwidth": "標準"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	タグのリソースが重複しています。
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	タグの数が上限を超えています。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	指定された TagValue パラメーターが無効です。
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	指定された TagKey パラメーターが無効です。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定された TagKey パラメーターが重複しています。

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

変更履歴

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