キュー項目の状態別件数を取得
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
このAPIは、指定したキュー内で、特定の状態にあるキュー項目の件数を集計するために使用します。
事前操作
1. 認可APIを使用してaccessTokenを取得します。
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/tool/queue/v1/queues/{queueUuid}/count | |
| HTTP Method | GET |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認可APIが返すaccess Tokenに置き換える必要があります |
リクエストパラメータ
queueUuidはURLパスで渡し、statusはURLクエリ文字列で渡します。
| 名称 | 位置 | タイプ | 必須 | 説明 |
|---|---|---|---|---|
| queueUuid | Path | String | はい | キューUUID |
| status | Query | String | はい | キュー項目の状態です。キュー項目の状態の列挙値:waiting effective(有効化待ち)、queued(待機中)、processing(処理中)、processed(処理済み)、exception(異常)、on hold(保留中)、expired(タイムアウトにより有効期限切れ)。 |
説明:このAPIは、queueUuidに対応するキューが存在するかどうかを検証しません。キューが存在しない場合は、エラーを報告せず、そのまま0を返します。
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| data | integer | 集計結果:指定したキュー内で、指定した状態にあるキュー項目の件数 |
| code | integer | 戻り値の結果コードです。200は成功、その他は失敗を示します |
| success | boolean | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます |
| requestId | string | リクエストidです。問題の調査に使用します |
| serverIp | string | 処理サービスのIP |
| serverInstName | string | 処理サービスのインスタンス名 |
| msg | string | ステータスコードの説明 |
レスポンスデータの例
| { "data": 25, "code": 200, "success": true, "requestId": "2f296259-d953-4939-9701-bc28ac43e002", "serverIp": "10.10.1.21", "serverInstName": "xybot-tool-service-01", "msg": null } |
|---|
想定されるエラーコード
| code | 説明 |
|---|---|
| 401 | 未認可です。accessTokenが無効であるか、指定されていません。まず認可を完了してaccessTokenを取得する必要があります |
| 10010107 | キュー項目の状態がサポートされていません(statusが有効な列挙値ではありません) |
| 10010102 | キュー項目のデータを読み取るためにDBを呼び出した際にエラーが発生しました |
使用例
curlの例
| curl --location --request GET 'https://api.example.com/oapi/tool/queue/v1/queues/{queueUuid}/count?status=queued' \ --header 'Authorization: Bearer {accessToken}' |
|---|