Compute Systems Manager REST API リファレンスガイド

[目次][前へ][次へ]

5.13 OSをシャットダウンしないでホストの電源をOFFにする

instanceIDに指定したホストのOSをシャットダウンしないで電源をOFFにします。

ロール

Admin/Modify

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Hosts/＜instanceID＞/actions/Poweroff/invoke

instanceID:
IPアドレスをbase64urlでエンコードした文字列。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

HostPowerOff 

{
        "schedule":"...",
        "time":"...",
        "elapseTime":...,
        "emailNotificationType":"..."
}
属性 データ型 数 説明
schedule string 0～1 ホストの電源を強制的にOFFにするスケジュールを指定します。
  • NOW：即時開始
  • LATER：timeで指定した日時に開始。LATER を指定する場合は，timeも合わせて指定してください。
デフォルトの値はNOWです。
time string 0～1 ホストの電源を強制的にOFFにする日付と時刻をYYYY/MM/DD HH:MM:SS の形式で指定します。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。
elapseTime integer 0～1 ホストの電源がOFFになるまでのタイムアウト時間を指定します。0から9999(単位：秒）の値を指定できます。
0を指定した場合，または省略した場合は，デフォルトの値が設定されます。デフォルトの値はGUIで設定されたタイムアウト時間です。
emailNotificationType string 0～1 Eメール通知の方法を指定します。
  • SEND：Eメールを送信します。
  • SEND_ONLY_TASK_FAILED：タスクが失敗したときだけEメールを送信します。
  • NOT_SEND：Eメールを送信しません。
デフォルトの値はNOT_SENDです。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult 

{
        "id":...
}
属性 データ型 数 説明
id integer 1 ホストの電源を強制的にOFFにするために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード 結果コード 詳細コード 説明
200 - - 正常終了。
400 2010 101 リクエストボディーの書式が無効です。JSONの書式で記述してください。
400 2010 102 elapseTimeに指定した値が範囲外です。
400 2010 103 scheduleに無効な値を指定しました。
400 2010 104 timeに無効な値を指定しました。
400 2010 105 emailNotificationTypeに無効な値を指定しました。
400 2010 107 scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 2010 108 指定した日付は2100年12月31日以降です。
401 1000 1 HTTPヘッダーのAuthorizationが指定されていません。
401 1000 2 HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 1000 3 HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 1000 4 ログインに失敗しました。
401 1002 1 ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 1003 1 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 2017 1 管理対象を参照または操作する権限がありません。
404 - - 指定したinstanceIDまたはcollectionはありません。
405 - - サポートされていないメソッドです。
406 2010 1 HTTPヘッダーのAcceptの値が不正です。
412 2018 106 timeに過去の時刻を指定しました。
415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 1000 1 ログインに失敗しました（内部エラー）。
500 3000 100 内部エラーが発生しました。
503 2020 1 要求の数がAPIの同時最大接続数を超えました。
503 2020 2 タスク登録に失敗しました。しばらくしてから，再度実行してください。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.