本文へジャンプします。

ニフクラ ユーザーガイド

NiftyModifyRouterAttribute

処理概要

指定したルーターの詳細情報を更新します。1回のリクエストで、1つのルーターサーバーの情報を更新できます。ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。

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

指定するパラメーター

パラメーター 説明 必須
RouterId string ルーターユニークID
○ (ルーター名といずれか)
RouterName string ルーター名
○ (ルーターユニークIDといずれか)
Attribute string 更新対象の項目名
値: routerName (ルーター名を更新) | description (メモを更新) | accountingType (利用料金タイプを更新) | type (ルータータイプを更新) | groupId (ファイアウォールを更新)
Value string 更新値
※Attribute=descriptionで空指定の場合、空で上書き
値: 1 (月額課金[Attribute=accountingType]) | 2 (従量課金[Attribute=accountingType]) | small (['Attribute=type']) | medium (['Attribute=type']) | large (['Attribute=type'])
Agreement boolean version up実施したのち、バックアップ状態を解除する事項への同意
値: True (同意する) | False (同意しない)
Default: False
○ (バックアップを保持する場合のみ)

応答フィールド

フィールド (項目) 説明
NiftyModifyRouterAttributeResponse - NiftyModifyRouterAttributeResponseレスポンス
Ancestor: なし
Children: requestId | return
requestId string リクエスト識別子
Ancestor: NiftyModifyRouterAttributeResponse
Children: なし
return boolean 処理ステータス
値: true(成功)
Ancestor: NiftyModifyRouterAttributeResponse
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyModifyRouterAttribute
  &RouterId=rt-8db04f81
  &Attribute=description
  &Value=RouterMemoUpdate
  &CommonParams

  

応答サンプル

    <NiftyModifyRouterAttributeResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyModifyRouterAttributeResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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