Create VPN service

VPNサービスを作成します。

URI

/v2.0/vpn/vpnservices

HTTPメソッド

POST

リクエストパラメタ

キー 説明 型 必須/省略可
subnet_id IPsec-VPN、またはSSL-VPNで接続するサブネット uuid-str Required
router_id VPNサービスが設定されている仮想ルータのID uuid-str Required
name VPNサービス名

一意である必要はありません。

 string Optional
admin_state_up VPNサービスの管理状態

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

 bool Optional
description VPNサービスの説明 string Optional
availability_zone アベイラビリティゾーン名

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

 xsd:string Optional

リクエスト例


{
  "vpnservice": {
    "subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
    "router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
    "name": "myservice",
    "admin_state_up": true,
    "availability_zone": "AZ1"
  }
}

レスポンスステータス

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

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


{
  "vpnservice": {
    "router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
    "status": "PENDING_CREATE",
    "name": "myservice",
    "admin_state_up": true,
    "subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
    "tenant_id": "ccb81365fe36411a9011e90491fe1330",
    "id": "9faaf49f-dd89-4e39-a8c6-101839aa49bc",
    "description": "",
    "availability_zone": "AZ1"
  }
}

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

要素名 説明
router_id VPNサービスが設定されている仮想ルータのID
status IPSec VPNサービスが現在動作しているかどうかを示します。

値は次のいずれかです: ACTIVE、DOWN、BUILD、ERROR、PENDING_CREATE、 PENDING_UPDATE、PENDING_DELETE
name VPNサービス名

一意である必要はありません。
admin_state_up VPNサービスの管理状態

"false"(停止中)の場合、ポートはパケットを転送しません。
subnet_id IPSec-VPN、またはSSL-VPNで接続するサブネット
tenant_id VPNサービスの所有者

自分のプロジェクト以外のプロジェクトIDを指定できるユーザーは管理者だけです。
id VPNサービスID
description VPNサービスの説明
availability_zone アベイラビリティゾーン名