GET /api/dlmlocks
List all DLM locks

パラメーター

パラメーター名 記述
search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/dlmlocks/:id
Show a DLM lock

GET /api/dlmlocks/:id/lock
Show a DLM lock

エラー

エラーコード エラー説明
404 Lock could not be found.

パラメーター

パラメーター名 記述
id
必須

Id or name of the DLM lock

Validations:

  • Must be a String


POST /api/dlmlocks
Create a DLM lock

パラメーター

パラメーター名 記述
dlmlock
必須

Validations:

  • Must be a Hash

dlmlock[name]
必須

名前

Validations:

  • Must be a String

dlmlock[type]
必須

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.

dlmlock[enabled]
任意 , nil可

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0


PUT /api/dlmlocks/:id
Update a DLM lock

パラメーター

パラメーター名 記述
id
必須

Id or name of the DLM lock

Validations:

  • Must be a String

dlmlock
必須

Validations:

  • Must be a Hash

dlmlock[name]
任意

名前

Validations:

  • Must be a String

dlmlock[type]
任意

Type, e.g. Dlmlock:Update

Validations:

  • Must be one of: Dlmlock:Update.

dlmlock[enabled]
任意 , nil可

Enable the lock

Validations:

  • Must be one of: true, false, 1, 0


DELETE /api/dlmlocks/:id
Delete a DLM lock

パラメーター

パラメーター名 記述
id
必須

Id or name of the DLM lock

Validations:

  • Must be a String


PUT /api/dlmlocks/:id/lock
Acquire a DLM lock

Acquire a lock

This action acquires a lock. It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

エラー

エラーコード エラー説明
200 Lock acquired successfully.
412 Lock could not be acquired.

パラメーター

パラメーター名 記述
id
必須

Id or name of the DLM lock

Validations:

  • Must be a String


DELETE /api/dlmlocks/:id/lock
Release a DLM lock

Release a lock

This action releases a lock.
It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

エラー

エラーコード エラー説明
200 Lock released successfully.
412 Lock could not be released.

パラメーター

パラメーター名 記述
id
必須

Id or name of the DLM lock

Validations:

  • Must be a String