Create IPsec site connection

IPsecサイト接続を作成します。

URI

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

HTTPメソッド

POST

リクエストパラメタ

キー 説明 型 必須/省略可
psk PSK(事前共有鍵): 任意の文字列 string Required
initiator このVPNが接続に応答するだけか、開始も行うかを指定します。"bi-directional"または"response-only"を選択してください。

(デフォルト: bi-directional)

 string Optional
ipsecpolicy_id IPsecポリシーID uuid-str Required
admin_state_up VPN接続の管理状態

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

(デフォルト: true)

 bool Optional
peer_cidrs ピアのプライベートCIDR

<net_address>/<prefix>の書式で示される有効なCIDRの固有リスト。指定可能なCIDRは1つだけです。

 list Required
ikepolicy_id IKEポリシーID uuid-str Required
dpd DPD (Dead Peer Detection)プロトコルの制御

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

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

(デフォルト: {'action' : 'hold', 'interval' : 30, 'timeout' : 120)

 dict Optional
vpnservice_id VPNサービスID uuid-str Required
peer_address ピアのゲートウェイ公開IPv4アドレス

(CIDR表記での指定はできません。)

 string Required
peer_id ピアのルーターの認証情報

有効な値は、IPv4/IPv6アドレス(CIDR表記での指定はできません)、メールアドレス、キーID、またはFQDNです。

 string Required
name IPsecサイト間接続の名前 string Optional
description IPsecサイト間接続の説明 string Optional
availability_zone アベイラビリティゾーン名

指定しなかった場合、リソースはデフォルトのアベイラビリティゾーンに作成されます。

 xsd:string Optional

リクエスト例


{
  "ipsec_site_connection": {
    "psk": "secret",
    "initiator": "bi-directional",
    "ipsecpolicy_id": "22b8abdc-e822-45b3-90dd-f2c8512acfa5",
    "admin_state_up": true,
    "peer_cidrs": [
      "10.2.0.0/24"
    ],
    "ikepolicy_id": "d3f373dc-0708-4224-b6f8-676adf27dab8",
    "dpd": {
      "action": "hold",
      "interval": 60,
      "timeout": 240
    },
    "vpnservice_id": "7b347d20-6fa3-4e22-b744-c49ee235ae4f",
    "peer_address": "172.24.4.233",
    "peer_id": "172.24.4.233",
    "name": "vpnconnection1",
    "availability_zone": "AZ1"
  }
}

レスポンスステータス

ステータスコード 説明
201 Normal response codes
Unauthorized (401) Error response codes
Bad Request (400) Error response codes

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


{
  "ipsec_site_connection": {
    "status": "PENDING_CREATE",
    "psk": "secret",
    "initiator": "bi-directional",
    "name": "vpnconnection1",
    "admin_state_up": true,
    "tenant_id": "b6887d0b45b54a249b2ce3dee01caa47",
    "description": "",
    "auth_mode": "psk",
    "peer_cidrs": [
      "10.2.0.0/24"
    ],
    "mtu": 1500,
    "ikepolicy_id": "d3f373dc-0708-4224-b6f8-676adf27dab8",
    "dpd": {
      "action": "hold",
      "interval": 60,
      "timeout": 240
    },
    "route_mode": "static",
    "vpnservice_id": "7b347d20-6fa3-4e22-b744-c49ee235ae4f",
    "peer_address": "172.24.4.233",
    "peer_id": "172.24.4.233",
    "id": "af44dfd7-cf91-4451-be57-cd4fdd96b5dc",
    "ipsecpolicy_id": "22b8abdc-e822-45b3-90dd-f2c8512acfa5",
    "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 プロジェクトID
description IPsecサイト間接続の説明
auth_mode 認証モード: psk
peer_cidrs ピアのプライベートCIDR
mtu 断片化を解消するためのMTU

(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ポリシーID
availability_zone アベイラビリティゾーン名

注意:
リソース作成後、接続相手先の設定が完了しているにも関わらず、statusがACTIVEにならない場合、「List IPsec site connections」の注意点に記載の事項に関して確認してください。