モジュール名: mutex

機能名	説明
list	Mutexの一覧を取得します
unlock	Mutexロックを解除します

機能名: list

現在ロック中のMutex一覧を取得します。

HTTPメソッド	リクエストURL
GET	http://{Hostname}:{Port}/api/mutex/list

なし

GET /api/mutex/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功するとMutexの一覧が返ります。
Mutexの情報としては次の情報が取得できます。

• Mutex ID
• ロック状態
  ロックされている場合は「true」、ロックされていない場合は「false」
  タイミングによっては「false」となることがありますが、基本的には「true」が返ります

<result>
	<status>success</status>
	<data>
		<mutex>
			<id>test_mutex1</id>
			<status>true</status>
		</mutex>
		<mutex>
			<id>test_mutex2</id>
			<status>true</status>
		</mutex>
	</data>
</result>

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード	HTTPステータスコード	説明
2001	403 Forbidden	ログインしていなかった場合

▲ このページのトップへ

機能名: unlock

Mutexロックを強制的に解除します。

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/api/mutex/unlock

パラメーター	必須	説明
id	はい	ロックを解除するMutexのIDを指定します。

POST /api/mutex/unlock HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Length: 14

id=test_mutex1

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行に成功しても特に情報は返りません。

<result>
	<status>success</status>
	<data></data>
</result>

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	idパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合

▲ このページのトップへ