本文へジャンプします。

ニフティクラウド APIリファレンス

nifty-modify-router-attribute

処理概要

API「NiftyModifyRouterAttribute」が実行されます。
指定したルーターの詳細情報を更新します。1回のリクエストで、1つのルーターの情報を更新できます。
ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。

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

コマンド構文

nifty-modify-router-attribute [オプション]

オプション

オプション 短縮 説明 必須
--router-id -r ルーターユニークIDを指定します。
(ルーター名といずれか)
--router-name -R ルーター名を指定します。
(ルーターユニークIDといずれか)
--router-name-update   ルーター名を更新します。  
--description   メモを更新します。
空の場合、空で上書き
 
--accounting-type   利用料金タイプを更新します。
1 (月額課金) | 2 (従量課金)
 
--type   ルータータイプを更新します。
small | medium | large
 
--agreement   version up実施したのち、バックアップ状態を解除する事項への同意を指定します。
(バックアップを保持する場合のみ)

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • routerId or routerName
  • 属性名(指定したパラメーターによって異なります)
  • value

実行サンプル

PROMPT>nifty-modify-router-attribute -r nrt-8db04f81 --router-name-update RouterNameUpdate
nrt-8db04f81 routerNameUpdate RouterNameUpdate

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

APIメニュー

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

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