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

StopInstances

処理概要

指定したサーバーを停止します。

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

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

なお、強制オプションに「true」を指定して実行した際に、サーバーが停止できない状態などのエラーが返されることがあります。強制オプションに「true」を指定して実行した場合には、システムチェックや修復を行うことをおすすめします。

指定するパラメーター

パラメーター	型	説明	必須
InstanceId.n	string	サーバー名	○
Force	boolean	強制オプション ※「true」を指定すると、停止できない状態にあるサーバーで停止処理を強制実行する。 値: true (強制実行) false (強制実行しない) Default: false
Tenancy.n	string	テナント属性 値: default (通常) dedicated (専有) Default: default

応答フィールド

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

リクエストサンプル

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

  

応答サンプル

    <StopInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <instancesSet>
    <item>
      <instanceId>server04</instanceId>
      <instanceUniqueId>i-efjh1234</instanceUniqueId>
      <currentState>
        <code>0</code>
        <name>pending</name>
      </currentState>
      <previousState>
        <code>16</code>
        <name>running</name>
      </previousState>
      <tenancy>default</tenancy>
    </item>
  </instancesSet>
</StopInstancesResponse>