NiftyModifyVpnGatewayAttribute
処理概要
指定された拠点間VPNゲートウェイの詳細情報を更新します。1回のリクエストで、1つの拠点間VPNゲートウェイの情報を更新できます。
拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイIDまたは拠点間VPNゲートウェイ名が必要です。
拠点間VPNゲートウェイ名、拠点間VPNゲートウェイタイプの更新時、拠点間VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| VpnGatewayId | string |
拠点間VPNゲートウェイユニークID |
○ (拠点間VPNゲートウェイ名といずれか) |
| NiftyVpnGatewayName | string |
拠点間VPNゲートウェイ名 |
○ (拠点間VPNゲートウェイユニークIDといずれか) |
| Attribute | string |
更新対象の項目名 値: niftyVpnGatewayName (拠点間VPNゲートウェイ名を更新) | niftyVpnGatewayType (拠点間VPNゲートウェイタイプを更新) | niftyVpnGatewayDescription (メモを更新) | niftyVpnGatewayAccountingType (利用料金タイプを更新) | groupId (ファイアウォールを更新) |
○ |
| Value | string |
更新値 ※Attribute=niftyVpnGatewayDescriptionで空指定の場合、空で上書き 値: small (['Attribute=niftyVpnGatewayType']) | medium (['Attribute=niftyVpnGatewayType']) | large (['Attribute=niftyVpnGatewayType']) | 1 (月額課金[Attribute=accountingType]) | 2 (従量課金[Attribute=accountingType]) |
○ |
| Agreement | boolean |
version up実施したのち、バックアップ状態を解除する事項への同意 値: True (同意する) | False (同意しない) Default: False |
○ (バックアップを保持する場合のみ) |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| NiftyModifyVpnGatewayAttributeResponse | - |
NiftyModifyVpnGatewayAttributeレスポンス Ancestor: なし Children: requestId | return |
| requestId | string |
リクエスト識別子 Ancestor: NiftyModifyVpnGatewayAttributeResponse Children: なし |
| return | boolean |
処理ステータス 値: true(成功) Ancestor: NiftyModifyVpnGatewayAttributeResponse Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyModifyVpnGatewayAttribute
&VpnGatewayId=vgw-8db04f81
&Attribute=niftyVpnGatewayDescription
&Value=VPNmemoUpdate
&CommonParams
応答サンプル
<NiftyModifyVpnGatewayAttributeResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyModifyVpnGatewayAttributeResponse>
