Hitachi

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


5.3.2 ストレージシステムの構成情報を更新する

対象となるストレージシステムから構成情報を取得して、REST APIサーバに保持しているストレージシステムの構成情報を更新します。
ヒント

次のような場合には、このAPIを利用してストレージシステムの構成情報を更新してください。

  • マイクロコードを更新した場合(新しい構成情報を取得できる場合があります)

  • REST APIをアップグレードした場合(REST APIサーバが更新されるので、新しい構成情報を取得できる場合があります)

実行権限

セキュリティ管理者(参照)またはセキュリティ管理者(参照・編集)VSP 5000 シリーズVSP E シリーズVSP Gx00 モデルVSP G1000VSP G1500VSP Fx00 モデルまたはVSP F1500の場合)

このAPIの実行に必要なロールはありません。(Virtual Storage PlatformまたはUnified Storage VMの場合)

リクエストライン

PUT <ベースURL>/v1/views/actions/refresh/invoke

このAPIはPOSTメソッドでも実行できます。

リクエストメッセージ

クエリパラメータ
なし。
ボディ
{
  "parameters": {
    "storageDeviceId": "800000010051"
  }
}

属性

説明

storageDeviceId

string

(必須)ストレージデバイスID

対象となるストレージシステムのストレージデバイスIDを1つだけ指定します。

レスポンスメッセージ

ボディ
{
  "refreshStatus" : {
    "storageDeviceId" : "800000010051",
    "status" : "Started",
    "lastSucceededTime" : "2016-03-23T04:45:03Z",
    "lastStartedTime" : "2016-03-23T07:21:07Z"
  }

}

属性

説明

refreshStatus

object

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

  • storageDeviceId(string)

    ストレージデバイスID

  • status(string)

    構成情報の更新状態

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

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

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

    • Failed:構成情報の更新処理が失敗した状態

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

  • lastSucceededTime(ISO8601string)

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

  • lastStartedTime(ISO8601string)

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

  • error(object)

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

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

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

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

Actionテンプレート

なし。

ステータスコード

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

コード例

curl -v -H "Accept: application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/views/actions/refresh/invoke