本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/NiftyModifyRouterAttribute.htmへ移行しました。 今後は新ページをご参照ください。

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 の場合
  

空指定の場合、空で上書き


Attribute=accountingType の場合
  • 1 (月額課金)
  • 2 (従量課金)
Attribute=type の場合
  • small
  • medium
  • large
Agreement boolean version up実施したのち、バックアップ状態を解除する事項への同意
値:
  • true (同意する)
  • false (同意しない)
Default: false
○ (バックアップを保持する場合のみ)

応答フィールド

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

リクエストサンプル

    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メニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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