本文へジャンプします。

ニフクラ APIリファレンス

NiftyUpdateRouterNetworkInterfaces

処理概要

指定したルーターのネットワークの割り当てを変更します。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。 またルーターに割り当てるネットワークを指定するためには、ネットワークIDまたはネットワーク名が必要です。削除済みのネットワークを指定した、管理外のネットワークを指定したなど、無効なネットワークを指定した場合は、エラーが返されます。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterId ルーターユニークID
Type : String

(ルーター名といずれか)
 
RouterName ルーター名
Type : String

(ルーターユニークIDといずれか)
 
NetworkInterface.n.DeviceIndex  ※指定不可
Type : Integer
Default : なし
   
NetworkInterface.n.SecurityGroupId.n  ※指定不可
Type : String
Default : なし
   
NetworkInterface.n.NetworkId ネットワークID
Type : String
値 : net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLAN のネットワーク ID

(ネットワーク名といずれか))
 
NetworkInterface.n.NetworkName ネットワーク名
Type : String

(ネットワークIDといずれか)
 
NetworkInterface.n.IpAddress IPアドレス
Type:String
Default:なし
   
NetworkInterface.n.Dhcp dhcp設定フラグ
Type : Boolean
Default : false
   
NetworkInterface.n.DhcpOptionsId dhcpオプションID
Type : String
Default : なし
   
NetworkInterface.n.DhcpConfigId ddhcpコンフィグID
Type:String
Default:なし
   
NiftyReboot 再起動オプション
Type : String
値 : force(強制再起動) | true(通常再起動)
Default : true
   
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type:bBoolean
Default:false

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

応答フィールド

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

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyUpdateRouterNetworkInterfaces&RouterName=router1&NetworkInterface.1.NetworkName=network1

応答サンプル

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

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

APIメニュー

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

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