Compute Systems Manager REST API リファレンスガイド
HTTPでは,オブジェクトに対して実行できる操作がメソッドとして定義されています。
Compute Systems ManagerのAPIがサポートするHTTPメソッドを次に示します。
HTTP メソッド 説明 GET オブジェクトの一覧や情報を取得します。 POST オブジェクトを新規に作成してコレクションに追加します(例:認証情報の作成)。
次の場合,リクエストボディーでオブジェクトの属性に必要な値を設定する必要があります。
- オブジェクトの属性にデフォルト値が設定されていない場合
- オブジェクトの属性にデフォルト値が設定されている場合で,値をデフォルト値から変更したいとき
PUT オブジェクトの属性を変更します。
変更する属性の値はリクエストボディーで指定します。指定を省略した場合,デフォルト値,またはすでに設定されている値が引き継がれて設定されます。詳しくは各APIのトピックを参照して確認してください。DELETE オブジェクトを削除します。 非同期処理のAPIとタスクの状態確認について
GET,POST,および DELETEの処理は同期的に実行されます。PUTの処理は,APIによっては非同期に実行されます。非同期処理の APIの場合,処理対象のオブジェクトとは別に,非同期タスクが自動で生成されます。非同期タスクの終了を通知するイベントは発生しないため,次のとおり,タスクの状態をポーリングして確認する必要があります。
- 管理サーバに対してPUTメソッドを発行します。
同期処理のAPIの場合,処理の実行結果がレスポンスとして返却されます。
非同期処理のAPIの場合,非同期タスクの生成の成否とタスクIDがレスポンスとして返却されます。次の手順を実施してください。- 手順1で生成されたタスクのタスクIDを使用して,タスクの情報を取得するためのGETメソッドを発行します。
- 取得したタスクの状態が
Canceled
,Completed
,Skipped
またはFailed
になるまで手順2を定期的に実行します。
All Rights Reserved. Copyright© 2016, Hitachi, Ltd.