本文へジャンプします。

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

ModifyInstanceAttribute

処理概要

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId サーバー名
Type : String
server03
Attribute 更新対象の項目名
Type : String
値 : instanceType (サーバータイプを更新) | disableApiTermination (APIからのサーバー削除可否を更新) | instanceName (サーバー名を更新) | description (メモ情報を更新) | ipType (グローバルIPアドレスのタイプを更新) | groupId (ファイアウォールグループを更新) | accountingType(利用料金タイプを更新)
instanceType
Value

更新値
Type : String
[Attribute= instanceType]
値 : 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

[Attribute= disableApiTermination]
値 : true (削除不可) | false (削除可)
[Attribute= ipType]
値 : static (固定化) | none(グローバルIPなし)
[Attribute= accountingType]
値 : 1 (月額課金) | 2 (従量課金)

small4
NiftyReboot 再起動オプション(起動中のサーバータイプ or IPタイプ指定時のオプション)
Type : String
値: force(強制再起動) | true(通常再起動) | false(再起動しない)
Default : true
   
Force ホットスケールアップの実行オプション(※)
※NiftyReboot=false指定時のオプション
Type :boolean
値:true(実行する)| false(実行しない)
Default :false
   
Tenancy Type :String
値:dafault(通常)| dedicated(専有)
Default :default
   

応答フィールド

フィールド(項目) 説明 サンプル値
ModifyInstanceAttributeResponse ModifyInstanceAttributeレスポンス
Type : ModifyInstanceAttributeResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : ModifyInstanceAttributeResponse
Children : なし
1c432751-5a08-4eb4-a501-2052685c58a8
return 更新ステータス
Type : xsd:boolean
値 : true (成功)
Ancestor : ModifyInstanceAttributeResponse
Children : なし
true

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=ModifyInstanceAttribute&InstanceId=server03&Attribute=instanceType&Value=small4&CommonParams

応答サンプル

<ModifyInstanceAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>1c432751-5a08-4eb4-a501-2052685c58a8</requestId>
  <return>true</return>
</ModifyInstanceAttributeResponse>

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

APIメニュー

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

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