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

StartInstances

処理概要

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

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

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

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

UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。

指定するパラメーター

パラメーター	型	説明	必須
InstanceId.n	string	サーバー名	○
InstanceType.n	string	サーバータイプ 値: e-mini h2-mini mini c-small e-small h2-small small c-small2 e-small2 h2-small2 small2 c-small4 e-small4 h2-small4 small4 e-small8 h2-small8 small8 e-small16 h2-small16 small16 c-medium e-medium h2-medium medium c-medium4 e-medium4 h2-medium4 medium4 c-medium8 e-medium8 h2-medium8 medium8 e-medium16 h2-medium16 medium16 e-medium24 h2-medium24 medium24 c-large e-large h2-large large c-large8 e-large8 h2-large8 large8 e-large16 h2-large16 large16 e-large24 h2-large24 large24 e-large32 h2-large32 large32 e-extra-large8 h2-extra-large8 extra-large8 e-extra-large16 h2-extra-large16 extra-large16 e-extra-large24 h2-extra-large24 extra-large24 e-extra-large32 h2-extra-large32 extra-large32 e-extra-large48 h2-extra-large48 extra-large48 e-double-large16 h2-double-large16 double-large16 e-double-large24 h2-double-large24 double-large24 e-double-large32 h2-double-large32 double-large32 e-double-large48 h2-double-large48 double-large48 e-double-large64 h2-double-large64 double-large64 e-double-large96 h2-double-large96 double-large96 h2-triple-large32 triple-large32 h2-triple-large48 triple-large48 h2-triple-large64 triple-large64 h2-triple-large96 triple-large96 h2-triple-large128 triple-large128 h2-quad-large64 quad-large64 h2-quad-large96 quad-large96 h2-quad-large128 quad-large128 h2-septa-large128 septa-large128 Default: 現在の設定値
AccountingType.n	string	利用料金タイプ ※変更する場合、翌月からの反映になります。 値: 1 (月額課金) 2 (従量課金) Default: 現在の設定値
UserData	string	サーバー起動時スクリプト
UserData.Encoding	string	サーバー起動時スクリプトのエンコード Default: base64
NiftyIsBios	boolean	BIOS画面起動の可否 値: true (BIOS起動画面で停止) false (BIOS起動画面で停止しない) Default: false
Tenancy.n	string	テナント属性 値: default (通常) dedicated (専有) Default: default

応答フィールド

フィールド (項目)	型	説明
StartInstancesResponse	-	StartInstancesレスポンス
␣requestId	string	リクエスト識別子
␣instancesSet	-	対象サーバーの情報セット
␣␣item	-	対象サーバーの情報
␣␣␣instanceId	string	サーバー名
␣␣␣instanceUniqueId	string	サーバーユニークID
␣␣␣currentState	-	現在のサーバーのステータス
␣␣␣␣code	integer	現在のステータスコード 備考: 返却値 0 (pending),16 (running),80 (stopped)
␣␣␣␣name	string	現在のステータス名 値: pending (処理中) running (起動済み) stopped (停止済み)
␣␣␣previousState	-	直前のサーバーのステータス
␣␣␣␣code	integer	直前のステータスコード 備考: 返却値 0 (pending),16 (running),80 (stopped)
␣␣␣␣name	string	直前のステータス名 値: pending (処理中) running (起動済み) stopped (停止済み)
␣␣␣tenancy	string	テナント属性 値: default (通常) dedicated (専有)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=StartInstances
  &InstanceId.1=server04
  &CommonParams

  

応答サンプル

    <StartInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</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>
      <tenancy>default</tenancy>
    </item>
  </instancesSet>
</StartInstancesResponse>