仮想サーバー停止処理

オペレーション名

仮想サーバー停止

機能概要

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

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

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

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

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<instances>
  <instance instanceId="" instanceState="" />
</instances>
要素名 属性名 説明 備考
instances -    
instance - [仮想サーバー一覧/仮想サーバーID (名前)]で指定している仮想サーバー毎に出現します。  
instanceId 仮想サーバーのIDを出力します。  
instanceState 現在の仮想サーバーの状態を出力します。
  • [Running]:仮想サーバーが起動している状態です。
  • [Starting]:仮想サーバーが起動処理を行っている状態です。
  • [Stopped]:仮想サーバーが停止している状態です。
  • [Stopping]:仮想サーバーが停止処理を行っている状態です。
  • [Destroyed]:仮想サーバーが削除されている状態です。
 

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 説明 備考
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
<プロパティ名>が設定されていません。
[<プロパティ名>]が設定されていません。 [<プロパティ名>]を設定してください。
InvalidPropertyConfigurationException
タイムアウトは0より大きくなければなりません。
[接続先]で指定したグローバルリソースの[タイムアウト]に0以下の数値が入力されています。 [接続先]で指定したグローバルリソースの[タイムアウト]に0より大きい数値を入力してください。
InvalidPropertyConfigurationException
タイムアウトには整数または変数を入力してください。
[接続先]で指定したグローバルリソースの[タイムアウト]に数値以外の値が入力されています。 [接続先]で指定したグローバルリソースの[タイムアウト]に数値を入力してください。
NttcomCloudnClientException
Code=401, Message=unable to verify user credentials and/or request signature
[接続先]で指定したグローバルリソースの[APIキー]または[秘密鍵]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。
NttcomCloudnClientException
Code=431, Message=Unable to execute API command stoptvirtualmachineresponse due to invalid value <仮想サーバーID> for parameter id
[仮想サーバー一覧/仮想サーバーID (名前)]に入力した仮想サーバーの形式が不正です。 [仮想サーバー一覧/仮想サーバーID (名前)]に正しい仮想サーバーIDを入力してください。
NttcomCloudnTimeoutException
<タイムアウト>ミリ秒以内に仮想サーバーのステータスが変更されませんでした。
停止要求送信完了後、[接続先]で指定したグローバルリソースの[タイムアウト]以内に仮想サーバー停止が完了しませんでした。 [接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
NttcomCloudnTimeoutException
org.apache.http.conn.ConnectTimeoutException: Connect to <ホスト> timed out
ホストに接続中にタイムアウトが発生しました。 ネットワークの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
NttcomCloudnTimeoutException
java.net.SocketTimeoutException: Read timed out
ホストに接続後、ホストからの応答までにタイムアウトが発生しました。 ホストの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。

注意事項