サーバー停止

オペレーション名

サーバー停止

機能概要

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

データモデル

本コンポーネントのデータモデルはXML型です。
入出力のスキーマについては「スキーマ」を参照してください。

プロパティ

基本設定

項目名 必須/省略可 変数の使用 説明 補足
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  

必須設定

項目名 必須/省略可 変数の使用 説明 補足
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」プロパティにて、グローバルリソースの設定を編集することができます。
  
サーバー名一覧 必須
-
 停止するサーバー名を複数指定します。

各列は以下のボタンで操作することができます。
  • [追加]:
    列を追加します。
  • [上へ]:
    選択している列の順序を一つ上に上げます。
  • [下へ]:
    選択している列の順序を一つ下に下げます。
  • [削除]:
    列を削除します。
  
サーバー名一覧/サーバー名 必須 使用可 停止するサーバー名を選択または入力します。
  • 初期表示時には選択項目に何も表示されません。
  • [サーバー名一覧を取得]を押下すると[接続先]に作成しているサーバー名が選択項目に表示されます。
停止完了を待機 省略可 使用不可 サーバーが停止完了するまで待機するかどうかを選択します。
  • [チェックあり]:(デフォルト)
    サーバーが停止完了するまで処理を待機します。
  • [チェックなし]:
    サーバーに停止要求を送信すると待機せず後続の処理に進みます。
  • [チェックあり]の場合、処理開始から[接続先]で指定したグローバルリソースの[タイムアウト]に入力した値までサーバーの状態を確認し続けます。
    サーバーの停止完了を確認すると、後続の処理に進みます。
    [タイムアウト]に入力したミリ秒までにサーバーの停止完了を確認できない場合、エラーになります。
プロパティアクション
項目名 説明 補足
サーバー名一覧を取得 [接続先]に作成しているサーバー名を取得し、[サーバー名一覧/サーバー名]から選択できるようにします。  

スキーマ

<?xml version="1.0"?>
<instances>
  <instance name="" previousStatus="" currentStatus="" />
</instances>
要素名 属性名 説明 補足
instances      
instance   作成しているサーバー毎に出現します。  
name サーバーの名前を出力します。  
previousStatus 直前のサーバーの状態を出力します。
  • [running]:サーバーが起動している状態です。
  • [pending]:サーバーが起動/停止処理を行っている状態です。
  • [warning]:サーバーが起動前処理を行っている状態です。
  • [stopped]:サーバーが停止している状態です。
  
currentStatus 現在のサーバーの状態を出力します。
  • [running]:サーバーが起動している状態です。
  • [pending]:サーバーが起動/停止処理を行っている状態です。
  • [warning]:サーバーが起動前処理を行っている状態です。
  • [stopped]:サーバーが停止している状態です。
  

大容量データ処理

大容量データ処理に対応していません。

使用できるコンポーネント変数

コンポーネント変数名 説明
error_type エラーが発生したときに、エラーの種類を返します。
java.io.FileNotFoundExceptionというような形式で返されます。
エラーが発生しなかった時にはnullを返します。
バージョンにより、内容が変わる可能性があります。
error_message エラーが発生したときのエラーメッセージを返します。
バージョンにより、内容が変わる可能性があります。
error_trace エラーが発生したときのトレース情報を返します。
バージョンにより、内容が変わる可能性があります。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。 名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。 名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
キー名が設定されていません。インポートウィザードからキーのインポートを行ってください。		 [接続先]で指定したグローバルリソースの[キー名]が設定されていません。 [接続先]で指定したグローバルリソースからキーインポートウィザードを起動し、キーのインポートを行ってください。
InvalidPropertyConfigurationException
タイムアウトは0より大きくなければなりません。		 [接続先]で指定したグローバルリソースの[タイムアウト]に0以下の数値が入力されています。 [接続先]で指定したグローバルリソースの[タイムアウト]に0より大きい数値を入力してください。
InvalidPropertyConfigurationException
タイムアウトには整数または変数を入力してください。		 [接続先]で指定したグローバルリソースの[タイムアウト]に数値以外の値が入力されています。 [接続先]で指定したグローバルリソースの[タイムアウト]に数値を入力してください。
InvalidPropertyConfigurationException
サーバー名が設定されていません。		 [サーバー名一覧]に列がありません。または、[サーバー名一覧/サーバー名]を入力していません。 [サーバー名一覧/サーバー名]にサーバー名を入力してください。
NiftyCloudOperationTimeoutException
<タイムアウト>ミリ秒以内にサーバーのステータスが変更されませんでした。		 停止要求送信完了後、[接続先]で指定したグローバルリソースの[タイムアウト]以内にサーバー停止が完了しませんでした。 [接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
org.apache.axis2.AxisFault
The instance ID '<サーバー名>' does not exist.		 [サーバー名一覧/サーバー名]に入力したサーバーが存在しません。 [サーバー名一覧/サーバー名]に正しいサーバー名を入力してください。
org.apache.axis2.AxisFault
No password supplied by the callback handler for the user : "<キー名>"		 インポートしたキーが削除された可能性があります。 [接続先]で指定したグローバルリソースからキーインポートウィザードを起動し、キーのインポートを行ってください。
org.apache.axis2.AxisFault
Invalid SOAP Signature. Failed to check signature with X.509 cert.		 [接続先]で指定したグローバルリソースの[キー名]のキーにインポートしたクライアント証明書・秘密鍵が不正です。 ニフティクラウドWeb管理画面からダウンロードした正しいクライアント証明書・秘密鍵のファイルを指定し、キーのインポートを行ってください。
org.apache.axis2.AxisFault
This system was not able to validate the provided access credentials		 [接続先]で指定したグローバルリソースの[キー名]のキーにインポートしたクライアント証明書・秘密鍵が不正です。 [接続先]で指定したグローバルリソースからキーインポートウィザードを起動し、正しいクライアント証明書・秘密鍵を設定してキーのインポートを行ってください。
org.apache.axis2.AxisFault
The host did not accept the connection within timeout of <タイムアウト> ms		 ホストに接続中にタイムアウトが発生しました。 ネットワークの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
org.apache.axis2.AxisFault
Read timed out		 ホストに接続後、ホストからの応答までにタイムアウトが発生しました。 ホストの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。

注意事項