インスタンス停止処理

オペレーション名

インスタンス停止

機能概要

Amazon EC2のインスタンスを停止します。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  
インスタンス一覧 必須 使用可 停止するインスタンスのインスタンスIDを複数指定します。

各インスタンスは以下のボタンで操作することができます。
  • [追加]:
    インスタンスを追加します。
  • [上へ]:
    選択しているインスタンスの順序を一つ上に上げます。
  • [下へ]:
    選択しているインスタンスの順序を一つ下に下げます。
  • [削除]:
    インスタンスを削除します。
  
インスタンス一覧/インスタンスID (名前) 必須 使用可 停止するインスタンスのインスタンスIDを指定します。
  • 一覧には「インスタンスID (Nameタグの値)」と表示されます。
    Nameタグがない場合は「インスタンスID」と表示されます。
  • インスタンスIDのみを直接入力で指定することも可能です。
停止完了を待機 必須 使用可
  • [チェックあり]:(デフォルト)
    インスタンスが停止完了するまで処理を待機します。
  • [チェックなし停止:
    インスタンスに停止要求を送信すると待機せず後続の処理に進みます。
  • [チェックあり]の場合、処理開始から[接続先]で指定したグローバルリソースの[タイムアウト]に入力した値までインスタンスの状態を確認し続けます。
    インスタンスの停止完了を確認すると、後続の処理に進みます。
    [タイムアウト]に入力したミリ秒までにインスタンスの停止完了を確認できない場合、エラーになります。
プロパティアクション
項目名 説明 補足
インスタンス一覧を取得 [接続先]に作成しているインスタンスIDを取得し、[インスタンス一覧/インスタンスID (名前)]から選択できるようにします。 以下のインスタンスのインスタンスIDは取得されません。
  • スポットインスタンス
  • ルートデバイスタイプが「instance-store」のインスタンス
  • 状態が「shutting-down」または「terminated」のインスタンス
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<instances>
  <instance currentInstanceState="" instanceId="" previousInstanceState="" />
</instances>
要素名 属性名 説明 補足
instances      
instance   停止したインスタンスごとに出現します。  
currentInstanceState 現在のインスタンスの状態を出力します。
  • [running]:インスタンスが起動している状態です。
  • [pending]:インスタンスが起動処理を行っている状態です。
  • [stopping]:インスタンスが停止処理を行っている状態です。
  • [stopped]:インスタンスが停止している状態です。
  • [shutting-down]:インスタンスが終了処理を行っている状態です。
  • [terminated]:インスタンスが終了している状態です。
  
instanceId インスタンスIDを出力します。  
previousInstanceState 直前のインスタンスの状態を出力します。
  • [running]:インスタンスが起動している状態です。
  • [pending]:インスタンスが起動処理を行っている状態です。
  • [stopping]:インスタンスが停止処理を行っている状態です。
  • [stopped]:インスタンスが停止している状態です。
  • [shutting-down]:インスタンスが終了処理を行っている状態です。
  • [terminated]:インスタンスが終了している状態です。
  

大容量データ処理

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

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 説明 備考
error_code エラー(AmazonEC2Exception)発生時、発生したエラーに対応する Amazon Web Servicesのエラーコードが格納されます。
  • デフォルト値はnullです。
status_code エラー(AmazonEC2Exception)発生時、通信時のHTTPステータスコードが格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
AmazonEC2OperationTimeoutException
<タイムアウト>ミリ秒以内にインスタンスのステータスが変更されませんでした。		 停止要求送信完了後、[接続先]で指定したグローバルリソースの[タイムアウト]以内にインスタンス停止が完了しませんでした。 [接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
com.amazonaws.services.ec2.model.AmazonEC2Exception エラーメッセージにより、原因は異なります。 エラーメッセージの内容を確認してください。
com.amazonaws.SdkClientException 以下の原因により、リクエストの送信ができない状態です。
  • [接続先]で指定したグローバルリソースの[タイムアウト]の時間(ミリ秒)を超過したためAmazon EC2へリクエストの送信ができませんでした。
  • [接続先]で指定したグローバルリソースの[エンドポイント]に誤りがあります。
 [接続先]で指定したグローバルリソースの設定を確認してください。

注意事項