10.1　非同期処理のAPIのステータス情報を取得する : Hitachi Storage Advisor Embedded ガイド

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/command-status/＜オブジェクトID＞

リクエストメッセージ

オブジェクトID

非同期処理のAPIを実行したときに返却されたstatusResourceのURLの最後に出力されている数値を指定します。

返却されたstatusResourceの例：

"statusResource": "/ConfigurationManager/simple/v1/objects/command-status/3"

属性	型	説明
id	int	（必須）非同期処理のAPIの実行結果問い合わせ用ID

クエリパラメータ: なし。

ボディ: なし。

レスポンスメッセージ

ボディ

ボリュームを作成するAPIを実行した場合の例：

{
  "progress": "completed",
  "status": "normal",
  "affectedResources": [
    "/ConfigurationManager/simple/v1/objects/volumes/100"
  ],
  "operationDetails": [
    {
      "operationType": "CREATE",
      "resourceType": "Volume",
      "resourceId": "100"
    }
  ]
}

プールを削除するAPIを実行して失敗した場合の例：

{
  "progress": "completed",
  "status": "error",
  "errorResource": "/ConfigurationManager/simple/v1/objects/pools/63",
  "errorCode": {
    "SSB1": "2e11",
    "SSB2": "001f"
  },
  "errorMessage": "Snapshot or volume exists. Operation could not be completed.",
  "operationDetails": [
    {
      "operationType": "DELETE",
      "resourceType": "Pool",
      "resourceId": "63"
    }
  ]
}

属性	型	説明
progress	string	APIの進捗状況 `unexecuted`：APIが未実行であることを示す `processing`：APIが実行中であることを示す `completed`：APIが実行完了したことを示す
status	string	APIの実行結果の状態 `normal`：APIが成功した状態を示す `error`：APIが失敗した状態を示すこの属性は、APIの実行が完了した場合に出力されます。
affectedResources	string[]	操作対象のリソースにアクセスするためのURLの一覧 1つのAPIで複数のリソースを操作した場合は、すべての操作対象のリソースのURLが返ります。APIが途中で失敗した場合は、処理が完了したことを確認できたリソースのURLだけが返ります。リソースの削除操作が成功した場合、削除対象のリソースのURLが返ります。このURLにアクセスすると404エラーとなり、正常に削除されたことが確認できます。この属性は、APIの実行が成功した場合に出力されます。
errorResource	string	エラーが発生したURL この属性は、APIの実行が失敗した場合に出力されます。
errorCode	object	ストレージシステムのエラーコードストレージシステムでエラーが発生して、次に示すエラーコードがある場合にだけ値が返ります。 SSB1コード SSB2コードストレージシステムのエラーコードは、ストレージシステムの保守に必要になります。この属性は、APIの実行が失敗した場合に出力されます。
errorMessage	string	エラーメッセージの内容この属性は、APIの実行が失敗した場合に出力されます。
operationDetails	object[]	操作対象のリソースの詳細情報リソース種別に示すリソースに対して操作している場合に出力されます。 `operationType`（string）リソースに対する操作種別 `CREATE`：リソースが作成されたことを示す `UPDATE`：リソースが変更されたことを示す `DELETE`：リソースが削除されたことを示す `resourceType`（string）作成、変更、または削除が発生したリソースのリソース種別 `CommandStatus`：非同期処理のAPIのステータス情報に関するリソースであることを示す `Pool`：プールに関するリソースであることを示す `Port`：ポートに関するリソースであることを示す `Snapshot`：スナップショットに関するリソースであることを示す `Volume`：ボリュームに関するリソースであることを示す `resourceId`（string）作成、変更、または削除が発生したリソースのリソースID

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/command-status/3

10.1 非同期処理のAPIのステータス情報を取得する

10.1　非同期処理のAPIのステータス情報を取得する