本文へジャンプします。

ニフクラ ユーザーガイド

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 更新値
値: e-mini (['Attribute=instanceType']) | mini (['Attribute=instanceType']) | c-small (['Attribute=instanceType']) | e-small (['Attribute=instanceType']) | small (['Attribute=instanceType']) | c-small2 (['Attribute=instanceType']) | e-small2 (['Attribute=instanceType']) | small2 (['Attribute=instanceType']) | c-small4 (['Attribute=instanceType']) | e-small4 (['Attribute=instanceType']) | small4 (['Attribute=instanceType']) | e-small8 (['Attribute=instanceType']) | small8 (['Attribute=instanceType']) | e-small16 (['Attribute=instanceType']) | small16 (['Attribute=instanceType']) | c-medium (['Attribute=instanceType']) | e-medium (['Attribute=instanceType']) | medium (['Attribute=instanceType']) | c-medium4 (['Attribute=instanceType']) | e-medium4 (['Attribute=instanceType']) | medium4 (['Attribute=instanceType']) | c-medium8 (['Attribute=instanceType']) | e-medium8 (['Attribute=instanceType']) | medium8 (['Attribute=instanceType']) | e-medium16 (['Attribute=instanceType']) | medium16 (['Attribute=instanceType']) | e-medium24 (['Attribute=instanceType']) | medium24 (['Attribute=instanceType']) | c-large (['Attribute=instanceType']) | e-large (['Attribute=instanceType']) | large (['Attribute=instanceType']) | c-large8 (['Attribute=instanceType']) | e-large8 (['Attribute=instanceType']) | large8 (['Attribute=instanceType']) | e-large16 (['Attribute=instanceType']) | large16 (['Attribute=instanceType']) | e-large24 (['Attribute=instanceType']) | large24 (['Attribute=instanceType']) | e-large32 (['Attribute=instanceType']) | large32 (['Attribute=instanceType']) | e-extra-large8 (['Attribute=instanceType']) | extra-large8 (['Attribute=instanceType']) | e-extra-large16 (['Attribute=instanceType']) | extra-large16 (['Attribute=instanceType']) | e-extra-large24 (['Attribute=instanceType']) | extra-large24 (['Attribute=instanceType']) | e-extra-large32 (['Attribute=instanceType']) | extra-large32 (['Attribute=instanceType']) | e-extra-large48 (['Attribute=instanceType']) | extra-large48 (['Attribute=instanceType']) | e-double-large16 (['Attribute=instanceType']) | double-large16 (['Attribute=instanceType']) | e-double-large24 (['Attribute=instanceType']) | double-large24 (['Attribute=instanceType']) | e-double-large32 (['Attribute=instanceType']) | double-large32 (['Attribute=instanceType']) | e-double-large48 (['Attribute=instanceType']) | double-large48 (['Attribute=instanceType']) | e-double-large64 (['Attribute=instanceType']) | double-large64 (['Attribute=instanceType']) | e-double-large96 (['Attribute=instanceType']) | double-large96 (['Attribute=instanceType']) | triple-large48 (['Attribute=instanceType']) | triple-large64 (['Attribute=instanceType']) | triple-large96 (['Attribute=instanceType']) | triple-large128 (['Attribute=instanceType']) | quad-large128 (['Attribute=instanceType']) | quad-large256 (['Attribute=instanceType']) | septa-large256 (['Attribute=instanceType']) | true (削除不可[Attribute=disableApiTermination]) | false (削除可[Attribute=disableApiTermination]) | static (固定化[Attribute=ipType]) | none (グローバルIPなし[Attribute=ipType]) | 1 (月額課金[Attribute=accountingType]) | 2 (従量課金[Attribute=accountingType])
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レスポンス
Ancestor: なし
Children: requestId | return
requestId string リクエスト識別子
Ancestor: ModifyInstanceAttributeResponse
Children: なし
return boolean 処理ステータス
値: true(成功)
Ancestor: ModifyInstanceAttributeResponse
Children: なし

リクエストサンプル

    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>

  

ニフクラ サイト内検索

APIメニュー

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

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