キュー内のキュー項目一覧を取得

この記事の内容
  1. キュー項目一覧をページ単位で取得
  2. 事前操作
  3. リクエスト
  4. リクエストヘッダー
  5. リクエストパラメータ
  6. レスポンス
  7. レスポンスデータ構造
  8. レスポンスデータの例
  9. 想定されるエラーコード
  10. 使用例
  11. curlの例

キュー項目一覧をページ単位で取得

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}/queueItems
HTTP Method GET

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数を、認可APIが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

queueUuidはURLパスで渡し、その他のパラメータはURLクエリ文字列で渡します。

名称 位置 タイプ 必須 説明
queueUuid Path String はい キューUUID
status Query String いいえ キュー項目の状態による絞り込みです。指定しない場合は、すべての状態を対象に取得します。キュー項目の状態の列挙値:waiting effective(有効化待ち)、queued(待機中)、processing(処理中)、processed(処理済み)、exception(異常)、on hold(保留中)、expired(タイムアウトにより有効期限切れ)。
page Query Integer いいえ 現在のページ番号です。デフォルト値は1、最小値は1です
size Query Integer いいえ 1ページあたりの件数です。デフォルト値は10、指定可能な範囲は[10,100]です
filterField Query String いいえ 時間による絞り込みに使用するフィールド名です。デフォルト値はcreateTimeです
startTime Query Long いいえ 開始日時です。秒単位のタイムスタンプです
endTime Query Long いいえ 終了日時です。秒単位のタイムスタンプです

説明:このAPIは、まずqueueUuidに対応するキューが存在するかどうかを検証します。存在しない場合は、エラーコード10010001を返します。

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data array 結果データの一覧
├─ uuid string キュー項目UUIDです。形式は"{キューUUID}_{キュー項目UUID}"です
├─ name string キュー項目名
├─ status string キュー項目の状態です。キュー項目の状態の列挙値:waiting effective(有効化待ち)、queued(待機中)、processing(処理中)、processed(処理済み)、exception(異常)、on hold(保留中)、expired(タイムアウトにより有効期限切れ)。
├─ priority integer 優先度
├─ effectiveTime integer 有効時間です。秒単位のタイムスタンプです
├─ expireTime integer 有効期限です。秒単位のタイムスタンプです
├─ bizInfo string 業務情報
├─ description string 説明
├─ createTime integer 作成日時です。秒単位のタイムスタンプです
├─ updateTime integer 更新日時です。秒単位のタイムスタンプです
page object ページ分割情報
├─ total integer 総件数
├─ size integer 1ページあたりの件数
├─ page integer 現在のページ
├─ pages integer 総ページ数
├─ offset integer オフセット
├─ sortColumn string 並べ替えに使用するcolumnの名称
├─ order string 並べ替えの調整方法はdesc/ascです。デフォルトは降順です
code integer 戻り値の結果コードです。200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます
requestId string リクエストidです。問題の調査に使用します
serverIp string 処理サービスのIP
serverInstName string 処理サービスのインスタンス名
msg string ステータスコードの説明

レスポンスデータの例

{
    "data": [
        {
            "uuid": "8f1a2b3c-4d5e-6f70-8192-a3b4c5d6e7f8_c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "name": "订单-20240508001",
            "status": "queued",
            "priority": 1,
            "effectiveTime": 1715140153,
            "expireTime": 1715226553,
            "bizInfo": "{\"orderId\":\"20240508001\"}",
            "description": "",
            "createTime": 1715140153,
            "updateTime": 1715140153
        }
    ],
    "page": {
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "offset": 0,
        "sortColumn": "createTime",
        "order": "desc"
    },
    "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を取得する必要があります
10010001 キューが存在しません
10010107 キュー項目の状態がサポートされていません(statusが有効な列挙値ではありません)

使用例

curlの例

curl --location --request GET 'https://api.example.com/oapi/tool/queue/v1/queues/{queueUuid}/queueItems?status=queued&page=1&size=10' \
--header 'Authorization: Bearer {accessToken}'
OpenAPIの記事一覧ページの先頭へ ↑