本文へジャンプします。

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

nifty-stop-instances

処理概要

API「StopInstances」が実行されます。

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

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

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

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

コマンド構文

nifty-stop-instances [サーバー名 [サーバー名 [...]]] [オプション]

オプション

オプション 短縮 説明 必須
--force -f 強制的にサーバーを停止します。  

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • INSTANCE / instanceId
  • INSTANCE / previousState,name
  • INSTANCE / currentState,name

実行サンプル

PROMPT>nifty-stop-instances server01
INSTANCE  server01  running  pending

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

APIメニュー

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

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