NiftyModifyVpnGatewayAttribute
処理概要
指定されたVPNゲートウェイの詳細情報を更新します。1回のリクエストで、1つのVPNゲートウェイの情報を更新できます。
VPNゲートウェイを指定するためには、VPNゲートウェイIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイ名、VPNゲートウェイタイプの更新時、VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| VpnGatewayId | VPNゲートウェイユニークID Type : String |
○ （VPNゲートウェイ名といずれか） |
|
| NiftyVpnGatewayName | VPNゲートウェイ名 Type : String |
○ （VPNゲートウェイユニークIDといずれか） |
|
| Attribute | 更新対象の項目名 Type : String 値: niftyVpnGatewayName（VPNゲートウェイ名を更新） | niftyVpnGatewayType（VPNゲートウェイタイプを更新） | niftyVpnGatewayDescription（メモを更新） | niftyVpnGatewayAccountingType（利用料金タイプを更新）| groupId（ファイアウォールを更新） |
○ | |
| Value | 更新値 Type : String 値 : [Attribute=niftyVpnGatewayType] small | medium | large [Attribute=niftyVpnGatewayDescription] 空指定の場合、空で上書き [Attribute=accountingType] 1 (月額課金) | 2 (従量課金) |
○ | |
| Agreement | version up実施したのち、バックアップ状態を解除する事項への同意 Type:bBoolean Default:false |
○ （バックアップを保持する場合のみ） |
応答フィールド
| フィールド | 説明 | サンプル値 |
|---|---|---|
| NiftyModifyVpnGatewayAttributeResponse | NiftyModifyVpnGatewayAttributeレスポンス Type : NiftyModifyVpnGatewayAttributeResponseType Ancestor : なし Children : requestId, return |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyModifyVpnGatewayAttributeResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| return | 更新ステータス Type : xsd: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://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyModifyVpnGatewayAttributeResponse>
