edit-icon download-icon

DescribeVpnConnections

最終更新日: May 05, 2018

説明

IPsec コネクションのリストを照会します。

リクエストパラメーター

名前必須かどうか説明
ActionStringはい

実行するアクション。

有効値:DescribeVpnConnections

RegionIdStringはい

IPsec コネクションのリージョン。

リージョン ID を取得するには、DescribeRegions API を呼び出します。

VpnGatewayIdStringいいえVPN Gateway の ID。
CustomerGatewayIdStringいいえカスタマーゲートウェイの ID。
PageNumberIntegerいいえ戻されるページ数。デフォルト値は 1 です。
PageSizeIntegerいいえ1 ページあたりの行数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメーター

名前説明
RequestId String リクエストの ID。
VpnConnectionsJSON StringIPsec コネクションのリスト。
TotalCountInteger照会されたエントリの数。
PageNumberInteger現在のページ数。
PageSizeInteger現在のページのエントリ数。
VPNConnection オブジェクト
VpnConnectionIdString IPsec コネクションの ID。
CustomerGatewayIdStringカスタマーゲートウェイの ID。
VpnGatewayIdStringVPN Gateway の ID。
NameString IPsec コネクションの名前。
LocalSubnetString VPC の CIDR ブロック。
RemoteSubnetStringローカルデータセンターの CIDR ブロック。
CreateTimeLong IPsec コネクションの作成時間。
IkeConfig JSON Stringフェーズ 1 ネゴシエーションの設定。
IpsecConfigJSON Stringフェーズ 2 ネゴシエーションの設定。
statusString IPsec コネクションのステータス。

  • ike_sa_not_established:フェーズ 1 のネゴシエーションが失敗しました。
  • ike_sa_established:フェーズ 1 のネゴシエーションが成功しました。
  • ipsec_sa_not_established:フェーズ 2 ネゴシエーションが失敗しました。
  • ipsec_sa_established:フェーズ 2 ネゴシエーションが成功しました。

エラーコード

VPC API Error Center」をご参照ください。

リクエストの例

  1. https://vpc.aliyuncs.com/?Action=DescribeVpnConnections
  2. &RegionID=cn-hangzhou
  3. &<CommonParameters>

レスポンスの例

XML 形式

  1. <DescribeVpnConnectionsResponse>
  2. <PageNumber>1</PageNumber>
  3. <VpnConnections>
  4. <VpnConnection>
  5. <Name>vpn connection test</Name>
  6. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  7. <RemoteSubnet>2.2.2.0/24</RemoteSubnet>
  8. <IpsecConfig>
  9. <IpsecLifetime>86400</IpsecLifetime>
  10. <IpsecAuthAlg>sha1</IpsecAuthAlg>
  11. <IpsecPfs>group2</IpsecPfs>
  12. <IpsecEncAlg>aes</IpsecEncAlg>
  13. </IpsecConfig>
  14. <EffectImmediately>true</EffectImmediately>
  15. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  16. <CreateTime>1492753817000</CreateTime>
  17. <VpnConnectionId>vco-bp10lz7aejumd2vxoqgev</VpnConnectionId>
  18. <status>ipsec_sa_established
  19. <status>
  20. <LocalSubnet>1.1.1.0/24,1.1.2.0/24</LocalSubnet>
  21. <IkeConfig>
  22. <IkeEncAlg>aes</IkeEncAlg>
  23. <RemoteId>139.196.32.167</RemoteId>
  24. <IkePfs>group2</IkePfs>
  25. <IkeAuthAlg>sha1</IkeAuthAlg>
  26. <Psk>pgw6dy7d1i8in7x5</Psk>
  27. <IkeMode>main</IkeMode>
  28. <IkeLifetime>86400</IkeLifetime>
  29. <IkeVersion>ikev1</IkeVersion>
  30. <LocalId>116.62.69.64</LocalId>
  31. </IkeConfig>
  32. </VpnConnection>
  33. </VpnConnections>
  34. <TotalCount>1</TotalCount>
  35. <PageSize>10</PageSize>
  36. <RequestId>3F96DAF2-8A69-4E84-824A-E16E22308703</RequestId>
  37. </DescribeVpnConnectionsResponse>

JSON 形式

  1. {
  2. "PageNumber": 1,
  3. "VpnConnections": {
  4. "VpnConnection": [
  5. {
  6. "Name": "vpn connection test",
  7. "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
  8. "RemoteSubnet": "2.2.2.0/24",
  9. "IpsecConfig": {
  10. "IpsecLifetime": 86400,
  11. "IpsecAuthAlg": "sha1",
  12. "IpsecPfs": "group2",
  13. "IpsecEncAlg": "aes"
  14. },
  15. "EffectImmediately": true,
  16. "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj0fiu",
  17. "CreateTime": 1492753817000,
  18. "VpnConnectionId": "vco-bp10lz7aejumd2vxoqgev",
  19. "status": "ipsec_sa_established",
  20. "LocalSubnet": "1.1.1.0/24,1.1.2.0/24",
  21. "IkeConfig": {
  22. "IkeEncAlg": "aes",
  23. "RemoteId": "139.196.32.167",
  24. "IkePfs": "group2",
  25. "IkeAuthAlg": "sha1",
  26. "Psk": "pgw6dy7d1i8in7x5",
  27. "IkeMode": "main",
  28. "IkeLifetime": 86400,
  29. "IkeVersion": "ikev1",
  30. "LocalId": "116.62.69.64"
  31. }
  32. }
  33. ]
  34. },
  35. "TotalCount": 1,
  36. "PageSize": 10,
  37. "RequestId": "54A4B3D0-DF4D-4C54-B8DC-5DC8DD49C939"
  38. }