本文へジャンプします。

ニフクラ APIリファレンス

NiftyUpdateVpnGatewayNetworkInterfaces

処理概要

VPNゲートウェイのネットワーク設定変更をします。
VPNゲートウェイのユーザ所有ネットワークはIPアドレスが指定できます。
VPNゲートウェイを指定するためには、VPNゲートウェイIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。

VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
VpnGatewayId VPNゲートウェイユニークID
Type:String

(VPNゲートウェイ名といずれか)
 
NiftyVpnGatewayName VPNゲートウェイ名
Type:String

(VPNゲートウェイユニークIDといずれか)
 
NetworkInterface.IpAddress IPアドレス
Type:String
   
NiftyReboot 再起動オプション
Type:String
値: force(強制再起動) | true(通常再起動)
Default: true
   
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type: Boolean
Default: false

(バックアップを保持する場合のみ)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyUpdateVpnGatewayNetworkInterfacesResponse NiftyUpdateVpnGatewayNetworkInterfacesレスポンス
Type : NiftyUpdateVpnGatewayNetworkInterfacesResponseType
Ancestor :なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyUpdateVpnGatewayNetworkInterfacesResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理ステータス
Type :xsd:boolean
Ancestor :NiftyUpdateVpnGatewayNetworkInterfacesResponse
Children :なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyUpdateVpnGatewayNetworkInterfaces& NiftyVpnGatewayName=vpn1& NetworkInterface.IpAddress=192.168.0.2& NiftyReboot=force&CommonParams

応答サンプル

<NiftyUpdateVpnGatewayNetworkInterfacesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <return >true</return >
</NiftyUpdateVpnGatewayNetworkInterfacesResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上