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

指定されたリージョンで作成された 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:DescribeVpnGateways

list

VpnGateway。

acs:vpc:{#regionId}:{#accountId}:vpngateway/*

VpnGateway。

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	VPN ゲートウェイのリージョン ID。	cn-hangzhou
VpcId	string	任意	VPN ゲートウェイが属する仮想プライベートクラウド (VPC) の ID。	vpc-bp1m3i0kn1nd4wiw9****
VpnGatewayId	string	任意	VPN ゲートウェイの ID。	vpn-bp17lofy9fd0dnvzv****
Status	string	任意	VPN ゲートウェイのステータス。有効な値:	アクティブな
BusinessStatus	string	任意	VPN ゲートウェイの課金ステータス。有効な値:	法線
PageNumber	integer	任意	リストのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。有効な値: 1 ～ 50。デフォルト値: 10。	10
IncludeReservationData	boolean	任意	保留中の注文データを含めるかどうかを指定します。有効な値:	true
Tag	array<object>	任意	VPN ゲートウェイにバインドされているタグのリスト。
	object	任意	VPN ゲートウェイにバインドされているタグ。
Key	string	任意	タグキー。	FinanceDept
Value	string	任意	タグ値。	FinanceJoshua
ResourceGroupId	string	任意	VPN ゲートウェイが属するリソースグループの ID。	rg-acfmzs372yg**** [ListResourceGroups](~~158855~~) 操作を呼び出して、リソースグループ ID をクエリできます。 [ListResourceGroups](~~158855~~) 操作を呼び出して、リソースグループ情報をクエリできます
GatewayType	string	任意	VPN ゲートウェイのタイプ。有効な値:	Enhanced.SiteToSite

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。ページングに使用されます。	10
RequestId	string	リクエスト ID。	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
PageNumber	integer	リストのページ番号。	1
TotalCount	integer	エントリの総数。	1
VpnGateways	object
VpnGateway	array<object>	VPN ゲートウェイのリスト。
	array<object>	VPN ゲートウェイの情報。
VpnType	string	VPN ゲートウェイのタイプ。法線。	法線
Status	string	VPN ゲートウェイのステータス。法線。	アクティブな
VpcId	string	VPN ゲートウェイが属する VPC の ID。	vpc-bp1m3i0kn1nd4wiw9****
SslMaxConnections	integer	VPN ゲートウェイの SSL-VPN 接続の同時接続数の最大値。	5
Spec	string	VPN ゲートウェイのピーク帯域幅。M は単位 Mbit/s を示します。	5M
InternetIp	string	VPN ゲートウェイインスタンスがシングルトンネル IPsec-VPN 接続の作成をサポートしている場合、このアドレスは VPN ゲートウェイインスタンスの IP アドレスであり、IPsec-VPN 接続または SSL-VPN 接続の作成に使用できます。	47.12.XX.XX
CreateTime	integer	VPN ゲートウェイが作成された時間。単位: ミリ秒。	1515383700000
AutoPropagate	boolean	VPN ゲートウェイでルーティングの自動伝播特徴が有効になっているかどうかを示します。	true
ChargeType	string	VPN ゲートウェイの課金方法。	中国サイト例: Prepay。国際サイト例: POSTPAY
VpnGatewayId	string	VPN ゲートウェイの ID。	vpn-bp17lofy9fd0dnvzv****
Tag	string	VPN ゲートウェイのシステム生成ラベル。フォーマット。	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"Forwarding 1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	VPN ゲートウェイで IPsec-VPN 特徴が有効になっているかどうかを示します。	有効
EndTime	integer	VPN ゲートウェイインスタンスの有効期限切れの UNIX タイムスタンプ。単位: ミリ秒。	1518105600000
VSwitchId	string	VPN ゲートウェイが属する vSwitch の ID。	vsw-bp15lbk8sgtr6r5b0****
Description	string	VPN ゲートウェイの説明。	test
EnableBgp	boolean	VPN ゲートウェイの BGP 特徴の有効化ステータス。	true
BusinessStatus	string	VPN ゲートウェイの課金ステータス。	法線
SslVpn	string	VPN ゲートウェイで SSL-VPN 特徴が有効になっているかどうかを示します。	有効
Name	string	VPN ゲートウェイの名前。	test
NetworkType	string	VPN ゲートウェイのネットワークタイプ。	public
Tags	object
Tag	array<object>	VPN ゲートウェイにバインドされているタグのリスト。
	object	VPN ゲートウェイにバインドされているタグ情報。フォーマット。
Key	string	タグキー。	FinanceDept
Value	string	タグ値。	FinanceJoshua
ReservationData	object	保留中の注文データ。
Status	string	保留中の注文のステータス。スペックアップ。接続数。	1
ReservationOrderType	string	保留中の注文のタイプ。	TEMP_UPGRADE
ReservationIpsec	string	保留中の注文の IPsec-VPN 特徴の有効化ステータス。	有効
ReservationSpec	string	保留中の注文の帯域幅スペック。単位: Mbit/s。	5
ReservationSsl	string	保留中の注文の SSL-VPN 特徴の有効化ステータス。	有効
ReservationMaxConnections	integer	保留中の注文の SSL-VPN 接続の同時接続数の最大値。	5
ReservationEndTime	string	保留中の注文タイプが TEMP_UPGRADE (一時的なアップグレード) の場合、このパラメーターは一時的なスペックアップ/スペックダウンの復元時間を示します。	2021-07-20T16:00:00Z
DisasterRecoveryInternetIp	string	IPsec-VPN 接続を作成するためにシステムによって VPN ゲートウェイインスタンスに割り当てられた 2 番目の IP アドレス。	47.91.XX.XX
DisasterRecoveryVSwitchId	string	VPN ゲートウェイインスタンスに関連付けられている 2 番目の vSwitch の ID。	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	SSL-VPN 接続の IP アドレス。	47.74.XX.XX
ResourceGroupId	string	VPN ゲートウェイが属するリソースグループの ID。フォーマット。	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	VPN ゲートウェイインスタンス用にシステムによって作成されたエラスティックネットワークインターフェイス (ENI) のリスト。
	string	ENI の ID。	eni-7xvcxgmd4y2ypibn****
GatewayType	string	VPN ゲートウェイのタイプ。有効な値:	Enhanced.SiteToSite

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnGateways": {
    "VpnGateway": [
      {
        "VpnType": "法線",
        "Status": "アクティブな",
        "VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
        "SslMaxConnections": 5,
        "Spec": "5M",
        "InternetIp": "47.12.XX.XX",
        "CreateTime": 1515383700000,
        "AutoPropagate": true,
        "ChargeType": "中国サイト例: Prepay。国際サイト例: POSTPAY",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"Forwarding 1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
        "IpsecVpn": "有効",
        "EndTime": 1518105600000,
        "VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
        "Description": "test",
        "EnableBgp": true,
        "BusinessStatus": "法線",
        "SslVpn": "有効",
        "Name": "test",
        "NetworkType": "public",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "ReservationData": {
          "Status": "1",
          "ReservationOrderType": "TEMP_UPGRADE",
          "ReservationIpsec": "有効",
          "ReservationSpec": "5",
          "ReservationSsl": "有効",
          "ReservationMaxConnections": 5,
          "ReservationEndTime": "2021-07-20T16:00:00Z"
        },
        "DisasterRecoveryInternetIp": "47.91.XX.XX",
        "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
        "SslVpnInternetIp": "47.74.XX.XX",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "EniInstanceIds": {
          "EniInstanceId": [
            "eni-7xvcxgmd4y2ypibn****"
          ]
        },
        "GatewayType": "Enhanced.SiteToSite"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	指定された TagKey パラメーターが無効です。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	指定された TagValue パラメーターが無効です。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定された TagKey パラメーターが重複しています。
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden.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 を操作する権限があるかどうかを確認してください。

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

変更履歴

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