本文へジャンプします。

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

nifty-modify-instance-attribute

処理概要

API「ModifyInstanceAttribute」が実行されます。

指定したサーバーの詳細情報を更新します。1回のリクエストで、1つのサーバーの情報を更新できます。

サーバーを指定するためには、サーバー名が必要です。削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

サーバータイプの更新について、ホットスケールアップが可能なサーバーであれば、オプション「--reboot false --force」を指定することで、起動中の状態のまま、更新が可能です。ホットスケールアップが可能なサーバーかどうかはAPI「DescribeInstances」のレスポンス値「hotAdd」で確認できます。ただしサーバータイプの値によっては、「hotAdd」が可能となっていても更新できないサーバータイプがあります。

コマンド構文

nifty-modify-instance-attribute サーバー名 [オプション]

オプション

オプション 短縮 説明 必須
--instance-type TYPE -t サーバータイプを更新します。
e-mini | mini | e-small | small | e-small2 | small2 | e-small4 | small4 | e-small8 | small8 | e-medium | medium | e-medium4 | medium4 | e-medium8 | medium8 | e-medium16 | medium16 | medium24 | e-large | large | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96
 
--disable-api-termination BOOLEAN   APIからのサーバー削除の可否情報を更新します。
true (削除不可) | false (削除可)
 
--instance-name INSTANCE   サーバー名を更新します。  
--ip-type IPTYPE   IPアドレスのタイプを更新します。
static(固定化)| none(グローバルIPなし)
 
--group-id GROUP -g ファイアウォールグループを更新します。  
--description MEMO   メモ情報を更新します。  
--accounting-type 利用料金タイプ   利用料金タイプを更新します。  
--reboot REBOOT   再起動オプション(起動中のサーバータイプ or IPタイプ指定時のオプション)を指定します。
force(強制再起動) | true(通常再起動) | false(再起動しない)
Default : true
 
--force   ホットスケールアップを実行する際、指定します。(※)
※--reboot false指定時のオプション
 
--tenancy TENANCY   テナント属性を指定します。
default (通常) | dedicated (専有)
Default : default
 

出力要素

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

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

実行サンプル

PROMPT>nifty-modify-instance-attribute server01 --instance-type large
server01  instanceType large

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

APIメニュー

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

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