Update VPN service

ステータスがPENDING_*でなければ、IPSecサイト間接続を更新します。

URI

/v2.0/vpn/vpnservices/{service-id}

HTTPメソッド

PUT

リクエストパラメタ

キー 説明 型 必須/省略可
name VPNサービス名

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

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

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

 bool Optional
description VPNサービスの説明 string Optional

リクエスト例


{
  "vpnservice": {
    "description": "Updated description"
  }
}

レスポンスステータス

ステータスコード 説明
200 Normal response codes
Unauthorized (401) Error response codes
Bad Request (400) Error response codes
Not Found (404) Error response codes

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


{
  "vpnservice": {
    "router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
    "status": "ACTIVE",
    "name": "myvpn",
    "admin_state_up": true,
    "subnet_id": "25f8a35c-82d5-4f55-a45b-6965936b33f6",
    "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
    "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
    "description": "Updated 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 アベイラビリティゾーン名