Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


5.3.1 ストレージシステムの構成情報の更新状態を取得する

REST APIサーバで保持しているストレージシステムの構成情報の更新状態を取得します。取得したstatus属性やlastSucceededTime属性の結果から構成情報の更新が必要かどうかを確認できます。

実行権限

このAPIの実行に必要なロールはありません。

リクエストライン

GET <ベースURL>/v1/views/refresh-statuses

リクエストメッセージ

クエリパラメータ

指定できるクエリパラメータについては、情報検索で使用するクエリパラメータの説明を参照してください。

ボディ

なし。

レスポンスメッセージ

ボディ
{
  "data" : [ {
    "refreshStatus" : {
      "storageDeviceId" : "800000010051",
      "status" : "Succeeded",
      "lastSucceededTime" : "2017-12-25T01:21:03Z",
      "lastStartedTime" : "2017-12-25T01:18:00Z"
    }
  }, {
    "refreshStatus" : {
      "storageDeviceId" : "800000010057",
      "status" : "Succeeded",
      "lastSucceededTime" : "2017-12-25T01:24:48Z",
      "lastStartedTime" : "2017-12-25T01:22:32Z"
    }
  } ],
  "offset" : 0,
  "count" : 2,
  "totalCount" : 2
}

属性

説明

refreshStatus

object

構成情報の更新ステータス情報

  • storageDeviceId(string)

    ストレージデバイスID

  • status(string)

    構成情報の更新状態

    • Queued:構成情報の更新処理がキューイングされた状態

    • Started:構成情報の更新処理が開始された状態

    • Succeeded:構成情報の更新処理が成功した状態

    • Failed:構成情報の更新処理が失敗した状態、または構成情報の更新が必要な状態※1

    • PartiallyNotUpdated:構成情報の更新処理が一部失敗した状態※2

  • lastSucceededTime(ISO8601string)

    構成情報の更新処理が成功した最終時刻

  • lastStartedTime(ISO8601string)

    構成情報の更新処理が開始した最終時刻※3

  • error(object)

    エラーの情報を保持するオブジェクト

    status属性の値がFailedPartiallyNotUpdatedの場合に取得できます。

注※1 アップグレードインストールによってREST APIのデータベースが拡張された場合は、ストレージシステムの構成情報を更新する必要があります。ストレージシステムの構成情報を更新するAPIを実行してください。

注※2 ストレージシステムの構成変更の通知を受信したり、REST APIでストレージシステムの構成を変更したりしたタイミングで、構成情報の更新処理が失敗した場合に表示されます。

注※3 すでにREST APIサーバで構成情報の更新が実行中のストレージシステムに対して、ストレージシステムの構成情報を更新するAPIを実行すると、リクエストが無視されます。この場合、lastStartedTime属性の値はストレージシステムの構成情報を更新するAPIを実行した時刻より前になるときがあります。

デフォルトソートキー
refreshStatusのstorageDeviceId属性

ステータスコード

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

コード例

curl -v -H "Accept:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/views/refresh-statuses