Hitachi

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


3.14 リソースグループをロックする

APIを実行するユーザに割り当てられたリソースグループのリソースを、ほかのユーザから操作されないようロックします。ロックによる排他制御は、セッション単位に行われます。ロックされたリソースに対するリクエストでは、ロック時に指定したセッションのトークンを、Authorizationヘッダに指定します。

実行権限

ストレージ管理者(参照)

リクエストライン

PUT <ベースURL>/v1/<ストレージデバイスID>/services/resource-group-service/actions/lock/invoke

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

リクエストメッセージ

オブジェクトID
なし。
クエリパラメータ
なし。
ボディ
{
  "parameters": {
    "waitTime": 30
  }
}

属性

説明

waitTime

int

ロックのタイムアウト時間(秒)

対象のリソースが、すでにほかのセッションでロックされていた場合などに、タイムアウトするまで待機する最大時間を0 ~ 7200の値で指定します。

省略した場合、0が指定されたと見なされます。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。

属性

説明

affectedResources

ロックを取得したリソースグループのURL

ステータスコード

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

ステータスコード

メッセージ

説明

503

Service unavailable

同一セッションを使用したロックまたはアンロックのAPIが実行中のため、操作できません。

コード例

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/836000123456/services/resource-group-service/actions/lock/invoke