本文へジャンプします。

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

StartInstances

処理概要

指定したサーバーを起動します。

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

サーバーの起動には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

NiftyIsBiosをtrueに指定すると、BIOS起動画面で停止した状態となります。コンソールからBIOS設定操作を行ってください。

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId.n サーバー名
Type : String
server04
InstanceType.n サーバータイプ
Type : String
値 : 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-large4864 | double-large64 | e-double-large96 | double-large96
Default : 現在の設定値
   
AccountingType.n

利用料金タイプ

  • ※変更する場合、翌月からの反映になります。
    Type : String
    値 : 1 (月額課金) | 2 (従量課金)
    Default : 現在の設定値
   
UserData サーバー起動時スクリプト
Type: String
   
UserData.Encoding サーバー起動時スクリプトのエンコード
Type: String
値 : なし(プレーンテキスト) | base64
Default: base64
   
NiftyIsBios BIOS画面起動の可否
Type : boolean
値 : true(BIOS起動画面で停止) | false(BIOS起動画面で停止しない)
Default : false
   
Tenancy.n テナント属性
Type : String
値 : dafault (通常) | dedicated (専有) | all (全て)
Default : default
   

応答フィールド

フィールド(項目) 説明 サンプル値
StartInstancesResponse StartInstancesレスポンス
Type : StartInstancesResponseType
Ancestor : なし
Children : requestId, instancesSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : StartInstancesResponse
Children : なし
82625b74-ccaf-49d2-9baa-3fc3af444ebe
instancesSet 対象サーバーの情報セット
Type : InstanceStateChangeSetType
Ancestor : StartInstancesResponse
Children : item
 
item 対象サーバーの情報
Type : InstanceStateChangeType
Ancestor : instancesSet
Children : instanceId, instanceUniqueId, currentState, previousState
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server04
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-efjk1234
currentState 現在のサーバーのステータス
Type : InstanceStateType
Ancestor : item
Children : code, name
 
code 現在のステータスコード
Type : xsd: integer
値 : 0 (pending) | 16 (running) | 80 (stopped)
Ancestor : currentState
Children : なし
0
name 現在のステータス名
Type : xsd:string
値 : pending(処理中) | running(起動済み) | stopped(停止済み)
Ancestor : currentState
Children : なし
pending
previousState 直前のサーバーのステータス
Type : InstanceStateType
Ancestor : item
Children : code, name
 
code 直前のステータスコード
Type : xsd: integer
値 : 0 (pending) | 16 (running) | 80 (stopped)
Ancestor : previousState
Children : なし
80
name 直前のステータス名
Type : xsd:string
値 : pending(処理中) | running(起動済み) | stopped(停止済み)
Ancestor : previousState
Children : なし
stopped
tenancy テナンス属性
Type : xsd:string
値 : default (通常) | dedicated (専有)
Ancestor : item
Children : なし
default

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=StartInstances&InstanceId.1=server04&CommonParams

応答サンプル

<StartInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>82625b74-ccaf-49d2-9baa-3fc3af444ebe</requestId>
 <instancesSet>
  <item>
   <instanceId>server04</instanceId>
   <instanceUniqueId>i-efba9876</instanceUniqueId>
   <currentState>
    <code>0</code>
    <name>pending</name>
   </currentState>
   <previousState>
    <code>80</code>
    <name>stopped</name>
   </previousState>
  </item>
 </instancesSet>
</StartInstancesResponse>

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

APIメニュー

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

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