キュー項目を取り出す
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}}/dequeue | {{queueUuid}} をキューUUIDに置き換えます |
| HTTP Method | PATCH |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります |
| Accept | / |
リクエストパラメータ
なし
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| data | object | 結果データ |
| |─uuid | string | キュー項目uuid |
| |─name | string | 名称 |
| |─status | string | 状態 |
| |─priority | Integer | 優先度 |
| |─expireTime | Long | 有効期限です。値はタイムスタンプで、単位は秒です |
| |─bizInfo | string | 業務情報 |
| |─description | string | 説明 |
| |─createTime | Long | 作成日時です。値はタイムスタンプで、単位は秒です |
| |─updateTime | Long | 更新日時です。値はタイムスタンプで、単位は秒です |
| code | integer | 戻り値の結果コードです 200は成功、その他は失敗を示します |
| success | boolean | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます |
| requestId | string | リクエストidです。問題の調査に使用します |
| serverIp | string | 処理サービスのIP |
| serverInstName | string | 処理サービスのインスタンス名 |
| msg | string | ステータスコードの説明 |
レスポンスデータの例
{
"data": {
"uuid": "string",
"name": "string",
"status": "string",
"priority": 0,
"expireTime": 0,
"bizInfo": "string",
"description": "string",
"createTime": 0,
"updateTime": 0
},
"code": 0,
"success": true,
"requestId": "string",
"serverIp": "string",
"serverInstName": "string",
"msg": "string"
}
使用例
curlの例
curl --location --request PATCH 'https://api.example.com/oapi/tool/queue/v1/queues/{{queueUuid}}/dequeue' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: api.example.com'
その他
キュー項目の状態
| status | 説明 |
|---|---|
| queued | 待機中 |
| processing | 処理中 |
| processed | 処理済み |
| exception | 異常 |
| on hold | 保留中 |
| expired | タイムアウトにより有効期限切れ |