フローの実行スレッドの一覧を取得します。
HTTPメソッド | リクエストURL |
---|---|
GET | http://{Hostname}:{Port}/api/worker/list |
パラメーター | 必須 | 説明 |
---|---|---|
runOnly | いいえ |
実行中のスレッドのみの一覧を取得する場合は「true」を指定します。 省略時は「false」(すべてのスレッドの情報を取得)となります。 |
GET /api/worker/list HTTP/1.1 X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功すると実行スレッドの一覧が返ります。
実行スレッドの情報としては次の情報が取得できます。
<result> <status>success</status> <data> <worker> <threadId>1</threadId> <requestId>wait</requestId> <project></project> <flow></flow> <sessionId></sessionId> <requestTime></requestTime> </worker> <worker> <threadId>2</threadId> <requestId>ecfcdefa-eb5f-457d-8a6e-8cf918f4e613</requestId> <project>/guest.Project1</project> <flow>Flow1</flow> <sessionId>37eab8f3-28cb-4d17-b47f-b343b2e4209c</sessionId> <requestTime>2012-08-23T19:37:07 JST</requestTime> </worker> </data> </result>
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
2001 | 403 Forbidden | ログインしていなかった場合 |
指定の実行スレッドについての情報を取得します。
HTTPメソッド | リクエストURL |
---|---|
GET | http://{Hostname}:{Port}/api/worker/show |
パラメーター | 必須 | 説明 |
---|---|---|
threadId | はい |
情報を取得する実行スレッドのスレッド番号を指定します。 スレッド番号は、list APIの実行結果で取得できます。 |
timeout | いいえ |
実行スレッドの情報を取得するためのタイムアウト値を秒単位で指定します。 省略時は5秒となります。 |
GET /api/worker/show?threadId=7 HTTP/1.1 X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功すると実行スレッドの情報が返ります。
実行スレッドの情報としては次の情報が取得できます。
<result> <status>success</status> <data> <project>/guest.Project1</project> <flow>Flow1</flow> <component>Sleep1</component> <statusStr>12レコード目</statusStr> <exception></exception> </data> </result>
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
2000 | 400 Bad Request | threadIdパラメーターが存在しなかった場合 |
2001 | 403 Forbidden | ログインしていなかった場合 |
2002 | 404 Not Found | threadIdで指定したスレッドが実行中でなかった場合 |