キュー一覧の検索
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 | |
| HTTP Method | GET |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認可APIが返すaccess Tokenに置き換える必要があります |
リクエストパラメータ
URL Query String形式でパラメータを渡します。
| 名称 | 位置 | 型 | 必須かどうか | 説明 |
|---|---|---|---|---|
| keyword | Query | String | いいえ | キュー名のキーワードです。あいまい検索に使用します |
| page | Query | Integer | いいえ | 現在のページ番号です。デフォルトは1、最小値は1です |
| size | Query | Integer | いいえ | 1ページあたりの件数です。デフォルトは10、指定可能な範囲は[10,100]です |
レスポンス
レスポンスデータ構造
| 名称 | 型 | 説明 |
|---|---|---|
| data | array | 結果データの一覧 |
| ├─ uuid | string | キューUUID |
| ├─ name | string | キュー名 |
| page | object | ページ分割情報 |
| ├─ total | integer | 総件数 |
| ├─ size | integer | 1ページあたりの件数 |
| ├─ page | integer | 現在のページ |
| ├─ pages | integer | 総ページ数 |
| ├─ offset | integer | オフセット |
| ├─ sortColumn | string | 並べ替えに使用する列の名称 |
| ├─ 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", "name": "订单处理队列" } ], "page": { "total": 1, "size": 10, "page": 1, "pages": 1, "offset": 0, "sortColumn": null, "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を取得する必要があります |
| 10010002 | キューによるDBからのデータ読み取りでエラーが発生しました(キュー検索の失敗) |
使用例
curlの例
| curl --location --request GET 'https://api.example.com/oapi/tool/queue/v1/queues?keyword={keyword}&page=1&size=10' \ --header 'Authorization: Bearer {accessToken}' |
|---|