ニフクラAPI (コンピューティング: ModifyInstanceAttribute)

ModifyInstanceAttribute

処理概要

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

サーバーを指定するためには、サーバー名が必要です。

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

指定するパラメーター

パラメーター	型	説明	必須
InstanceId	string	サーバー名	○
Attribute	string	更新対象の項目名 値: instanceType (サーバータイプを更新) disableApiTermination (APIからのサーバー削除可否を更新) instanceName (サーバー名を更新) description (メモ情報を更新) ipType (グローバルIPアドレスのタイプを更新) groupId (ファイアウォールグループを更新) accountingType (利用料金タイプを更新)	○
Value	string	更新値 値: Attribute=instanceType の場合 e2-mini e-mini h2-mini mini c2-small c2r-small c-small e2-small e2r-small e-small h2-small h2r-small small c2-small2 c2r-small2 c-small2 e2-small2 e2r-small2 e-small2 h2-small2 h2r-small2 small2 c2-small4 c-small4 e2-small4 e-small4 h2-small4 h2r-small4 small4 e2-small8 e-small8 h2-small8 small8 e2-small16 e-small16 h2-small16 small16 c2-medium c2r-medium c-medium e2-medium e2r-medium e-medium h2-medium h2r-medium medium c2-medium4 c2r-medium4 c-medium4 e2-medium4 e2r-medium4 e-medium4 h2-medium4 h2r-medium4 medium4 c2-medium8 c-medium8 e2-medium8 e-medium8 h2-medium8 h2r-medium8 medium8 e2-medium16 e-medium16 h2-medium16 medium16 e2-medium24 e-medium24 h2-medium24 medium24 c2-large c2r-large c-large e2-large e2r-large e-large h2-large h2r-large large c2-large8 c-large8 e2-large8 e2r-large8 e-large8 h2-large8 h2r-large8 large8 e2-large16 e-large16 h2-large16 h2r-large16 large16 e2-large24 e-large24 h2-large24 large24 e2-large32 e-large32 h2-large32 large32 e2-extra-large8 e2r-extra-large8 e-extra-large8 h2-extra-large8 h2r-extra-large8 extra-large8 e2-extra-large16 e-extra-large16 h2-extra-large16 h2r-extra-large16 extra-large16 e2-extra-large24 e-extra-large24 h2-extra-large24 h2r-extra-large24 extra-large24 e2-extra-large32 e-extra-large32 h2-extra-large32 extra-large32 e2-extra-large48 e-extra-large48 h2-extra-large48 extra-large48 e2-double-large16 e2r-double-large16 e-double-large16 h2-double-large16 h2r-double-large16 double-large16 e2-double-large24 e-double-large24 h2-double-large24 h2r-double-large24 double-large24 e2-double-large32 e-double-large32 h2-double-large32 h2r-double-large32 double-large32 e2-double-large48 e-double-large48 h2-double-large48 double-large48 e2-double-large64 e-double-large64 h2-double-large64 double-large64 e2-double-large96 e-double-large96 h2-double-large96 double-large96 h2-triple-large32 h2r-triple-large32 triple-large32 h2-triple-large48 h2r-triple-large48 triple-large48 h2-triple-large64 triple-large64 h2-triple-large96 triple-large96 h2-triple-large128 triple-large128 h2-quad-large64 h2r-quad-large64 quad-large64 h2-quad-large96 quad-large96 h2-quad-large128 quad-large128 h2-quad-large256 quad-large256 h2-septa-large128 septa-large128 h2-septa-large256 septa-large256 h2-octa-large256 octa-large256 h2-octa-large384 octa-large384 h2-octa-large512 octa-large512 Attribute=disableApiTermination の場合 true (削除不可) false (削除可) Attribute=ipType の場合 static (固定化) none (グローバルIPなし) Attribute=accountingType の場合 1 (月額課金) 2 (従量課金)	○
NiftyReboot	string	再起動オプション（起動中のサーバータイプ or IPタイプ指定時のオプション） 値: force (強制再起動) true (通常再起動) false (再起動しない) Default: true
Force	boolean	ホットスケールアップの実行オプション ※NiftyReboot=false指定時のオプション 値: true (実行する) false (実行しない) Default: false
Tenancy	string	テナント属性 値: dafault (通常) dedicated (専有) Default: default

応答フィールド

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

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=ModifyInstanceAttribute
  &InstanceId=server03
  &Attribute=instanceType
  &Value=small4
  &CommonParams

  

応答サンプル

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