List IPsec site connections

IPsecサイト間接続の一覧を表示します。

URI

/v2.0/vpn/ipsec-site-connections

HTTPメソッド

GET

レスポンスステータス

ステータスコード 説明
200 Normal response codes
Unauthorized (401) Error response codes
Forbidden (403) Error response codes

レスポンスボディ(正常系)


{
  "ipsec_site_connections": [
    {
      "status": "PENDING_CREATE",
      "psk": "secret",
      "initiator": "bi-directional",
      "name": "vpnconnection1",
      "admin_state_up": true,
      "tenant_id": "ccb81365fe36411a9011e90491fe1330",
      "description": "",
      "auth_mode": "psk",
      "peer_cidrs": [
        "10.1.0.0/24"
      ],
      "mtu": 1500,
      "ikepolicy_id": "bf5612ac-15fb-460c-9b3d-6453da2fafa2",
      "dpd": {
        "action": "hold",
        "interval": 30,
        "timeout": 120
      },
      "route_mode": "static",
      "vpnservice_id": "c2f3178d-5530-4c4a-89fc-050ecd552636",
      "peer_address": "172.24.4.226",
      "peer_id": "172.24.4.226",
      "id": "cbc152a0-7e93-4f98-9f04-b085a4bf2511",
      "ipsecpolicy_id": "8ba867b2-67eb-4835-bb61-c226804a1584",
      "availability_zone": "AZ1"
    }
  ]
}
     

レスポンスボディ(正常系)の説明

要素名 説明
status VPNサービスのステータス

値は次のいずれかです: ACTIVE、DOWN、BUILD、ERROR、PENDING_CREATE、 PENDING_UPDATE、PENDING_DELETE

psk PSK(事前共有鍵): 任意の文字列
initiator このVPNが接続に応答するだけか、開始も行うかを指定します。
name IPSecサイト間接続の名前
admin_state_up VPN接続の管理状態

"false"(停止中)の場合、VPN接続はパケットを転送しません。

tenant_id VPNサービスID
description IPsecサイト間接続の説明
auth_mode 認証モード: psk
peer_cidrs ピアのプライベートCIDR
mtu 1回の転送(1フレーム)で送信できるデータの最大値
ikepolicy_id IKEポリシーID
dpd DPD (Dead Peer Detection)プロトコルの制御

アクションの値はhold またはrestartを指定します。

間隔とタイムアウトの値は秒単位で指定します。

route_mode ルートモード: static

今後拡張する予定です。

vpnservice_id VPNサービスID
peer_address ピアのゲートウェイ公開IPv4アドレス
peer_id ピアのルーターの認証情報

有効な値は、IPv4/IPv6アドレス、メールアドレス、キーID、またはFQDNです。

id IPsecコネクションID
ipsecpolicy_id IPsecポリシーの固有識別子
availability_zone アベイラビリティゾーン名

注意:
リソース作成後、接続相手先の設定が完了しているにも関わらず、statusがACTIVEにならない場合、以下のパラメータが接続相手先の情報と一致しているか確認してください。
  • IKE Policy
    • encryption_algorithm
    • pfs
    • lifetime
  • IPsec Policy
    • encryption_algorithm
    • pfs
    • lifetime
  • IPsec site connection
    • psk
    • peer_cidrs
    • peer_address
    • peer_id