本文へジャンプします。

ニフクラ ユーザーガイド

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レスポンス
Ancestor: なし
Children: requestId | instancesSet
requestId string リクエスト識別子
Ancestor: StopInstancesResponse
Children: なし
instancesSet - 対象サーバーの情報セット
Ancestor: StopInstancesResponse
Children: item
item - 対象サーバーの情報
Ancestor: instancesSet
Children: instanceId | instanceUniqueId | currentState | previousState
instanceId string サーバー名
Ancestor: item
Children: なし
instanceUniqueId string サーバーユニークID
Ancestor: item
Children: なし
currentState - 現在のサーバーのステータス
Ancestor: item
Children: code | name
code integer 現在のステータスコード
値: 0 (pending)
Ancestor: currentState
Children: なし
name string 現在のステータス名
値: pending(処理中)
Ancestor: currentState
Children: なし
previousState - 直前のサーバーのステータス
Ancestor: item
Children: code | name
code integer 直前のステータスコード
値: 16 (running) | 96 (warning)
Ancestor: previousState
Children: なし
name string 直前のステータス名
値: running(起動済み) | warning(異常あり)
Ancestor: previousState
Children: なし
tenancy string テナント属性
値: default(通常) | dedicated(専有)
Ancestor: item
Children: なし

リクエストサンプル

    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>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2020年11月25日時点の情報です。

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