Update VPN service#
VPNサービスを更新します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://nfv.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://nfv.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/vpn/nfv/vpnservices/{service-id}
HTTPステータスコード#
正常時:202
エラー時:400,404
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| service-id | path | string | 必須 | VPNサービスID |
| vpnservice | body | object | 必須 | VPNサービスのオブジェクト |
| name | body | string | 任意 | VPNサービスの名前 |
| admin_state_up | body | boolean | 任意 | VPNサービスの状態 「true」の場合は、VPNサービスは活性です。 「false」の場合は、VPNサービスは非活性です。 |
| description | body | string | 任意 | VPNサービスの説明 |
レスポンスボディ(正常系)の説明#
| 名前 | Type | Description |
|---|---|---|
| vpnservice | object | VPNサービスのオブジェクト |
| name | string | VPNサービスの名前 |
| admin_state_up | boolean | VPNサービスの状態 「true」の場合は、VPNサービスは活性です。 「false」の場合は、VPNサービスは非活性です。 |
| id | string | VPNサービスのID |
| description | string | VPNサービスの説明 |
リクエスト例#
{ "vpnservice": { "admin_state_up": true "name": "updateVPNservice" } }
レスポンス例#
{ "vpnservice": { "name": "vpnservice01", "admin_state_up": true, "id": "20" } }