白皮书下载
队列管理
一、队列新增
接口说明
该接口是为了提供队列管理功能，队列新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/add
HTTP method: POST
Content-Type: application/json
请求样例
{
"queueName": "openapi测试队列004", // 队列名称
"maxQueueNumber": 500, // 最大队列数量，最大队列数不能超过1000
"isExpire": true, // 是否时效队列，true-是，false-否，为true时，需要传递expireTime字段，为false时，不需要传递expireTime字段
"expireTime": 10, // 队列下消息的时效时间，单位：分钟
"remark": "openapi测试队列004备注" // 备注
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueName |
String |
是 |
队列名称（队列名称最大长度100位） |
|
maxQueueNumber |
Integer |
是 |
最大队列数(最大队列数不能超过1000) |
|
isExpire |
Boolean |
是 |
是否时效队列，true-是，false-否，为true时，需要传递expireTime字段，为false时，不需要传递expireTime字段 |
|
expireTime |
Integer |
否 |
过期时间，单位：分钟 |
|
remark |
String |
否 |
备注（备注长度最大长度不能超过100） |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueID": "1412322348656353282", // 队列ID
"queueUUID": "715d358ce6de467f98c400b81f46680a" // 队列UUID
}
}
二、队列更新
接口说明
该接口是为了提供队列管理功能，队列更新所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/update
HTTP method: POST
Content-Type: application/json
请求样例
{
"queueID": 1412322348656353282, // 队列ID，队列新增时返回获取
"queueName": "openapi测试队列004更新", // 队列名称
"maxQueueNumber": 100, // 最大队列数量，最大队列数不能超过1000
"isExpire": true, // 是否时效队列，true-是，false-否，为true时，需要传递expireTime字段，为false时，不需要传递expireTime字段
"expireTime": 10, // 队列下消息的失效时间，单位：分钟
"remark": "openapi测试队列004备注更新" // 备注
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueID |
Long |
是 |
队列ID，队列新增时获取 |
|
queueName |
String |
是 |
队列名称（队列名称最大长度100位） |
|
maxQueueNumber |
Integer |
是 |
最大队列数(最大队列数不能超过1000) |
|
isExpire |
Boolean |
是 |
是否时效队列，true-是，false-否，为true时，需要传递expireTime字段，为false时，不需要传递expireTime字段 |
|
expireTime |
Integer |
否 |
过期时间，单位：分钟 |
|
remark |
String |
否 |
备注（备注长度最大长度不能超过100） |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
三、队列删除
接口说明
该接口是为了提供队列管理功能，队列删除所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/delete
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412322348656353282, // 队列ID，队列新增时返回获取
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
队列ID，队列新增时获取 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
四、查询队列列表
接口说明
该接口是为了提供队列管理功能，队列列表查询所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/select-queue-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"queueUUID": "715d358ce6de467f98c400b81f46680a", // 队列UUID
"queueName": "openapi测试" // 队列名称（右模糊查询）
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueUUID |
String |
否 |
队列UUID，队列新增时获取 |
|
queueName |
String |
否 |
队列名称（右模糊查询） |
响应样例
{
"msg": "success",
"code": 0,
"data": [
{
"queueID": "1412322348656353282", // 队列ID
"queueUUID": "715d358ce6de467f98c400b81f46680a", // 队列UUID
"queueName": "openapi测试队列004更新", // 队列名称
"isExpire": true, // 是否时效队列，true-是，false-否
"expireTime": 480, // 队列下消息的失效时间，单位：分钟
"maxNumber": 100, // 最大队列数量
"remark": "openapi测试队列004备注更新", // 备注
"gmtCreated": "2021-07-06 16:07:48", // 创建时间
"gmtModified": "2021-07-06 16:15:56" // 修改时间
},
{
"queueID": "1411873004152594433",
"queueUUID": "2b9a0eebafcd46c5bf8f14577b8e13e8",
"queueName": "openapi测试队列0010",
"isExpire": true,
"expireTime": 600,
"maxNumber": 500,
"remark": "aaa",
"gmtCreated": "2021-07-05 10:22:16",
"gmtModified": "2021-07-05 10:23:16"
}
]
}
五、根据id查询队列详情
接口说明
该接口是为了提供队列管理功能，队列根据id查询队列详情所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/select-queue-by-id
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": , 1412322348656353282 // 队列ID,队列新增时获取
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
队列ID，队列新增时获取 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueID": "1412322348656353282", // 队列ID，队列新增时获取
"queueUUID": "715d358ce6de467f98c400b81f46680a", // 队列UUID
"queueName": "openapi测试队列004更新", // 队列名称
"isExpire": true, // 是否时效队列，true-是，false-否
"expireTime": 480, // 队列下消息的失效时间，单位：分钟
"maxNumber": 100, // 最大队列数量
"remark": "openapi测试队列004备注更新", // 备注
"gmtCreated": "2021-07-06 16:07:48", // 创建时间
"gmtModified": "2021-07-06 16:15:56" // 修改时间
}
}
六、根据队列名称精准查询队列详情（非模糊查询）
接口说明
该接口是为了提供队列管理功能，队列根据名称精准查询队列详情所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/select-queue-by-name
HTTP method: POST
Content-Type: application/json
请求样例
{
"name": "openapi测试队列004更新"
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
name |
String |
是 |
队列名称(精准查询，需要全匹配名称) |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueID": "1412322348656353282", // 队列ID，队列新增时获取
"queueUUID": "715d358ce6de467f98c400b81f46680a", // 队列UUID,队列新增时获取
"queueName": "openapi测试队列004更新", // 队列名称
"isExpire": true, // 是否时效队列，true-是，false-否
"expireTime": 480, // 队列下消息的失效时间，单位：分钟
"maxNumber": 100, // 最大队列数
"remark": "openapi测试队列004备注更新", // 备注
"gmtCreated": "2021-07-06 16:07:48", // 创建时间
"gmtModified": "2021-07-06 16:15:56" // 修改时间
}
}
七、查询消息列表
接口说明
该接口是为了提供队列管理功能，队列列表查询所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue-message/select-queue-message-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"queueUUID": "715d358ce6de467f98c400b81f46680a", // 队列UUID
"queueMessageID": 1386216671115882498, // 队列消息ID
"status": 1, // 状态:-1-已过期 1-未消费 2-已消费
"consumeType": 1, // 消费渠道 -1.未消费 1.bot 2.factory 3.topic
"isExpire": true // 是否是时效队列，true-是，false-否
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueUUID |
String |
否 |
队列UUID |
|
queueMessageID |
String |
否 |
队列消息ID |
|
status |
Integer |
否 |
状态:-1-已过期 1-未消费 2-已消费 |
|
consumeType |
Integer |
否 |
消费渠道 -1.未消费 1.bot 2.factory 3.topic |
|
isExpire |
Boolean |
否 |
是否是时效队列，true-是，false-否 |
响应样例
{
"msg": "success",
"code": 0,
"data": [
{
"queueMessageID": "22", // 队列消息ID
"queueID": "9", // 队列ID
"queueUUID": "4043806a0dfe480bbdcbae4931847eba", // 队列UUID
"source": "1", // 消息来源
"status": -1, // 消息状态:-1-已过期 1-未消费 2-已消费
"productTime": "2021-03-20 16:56:46", // 入队时间
"consumeTime": "2021-03-20 16:56:46",, // 消费时间
"isExpire": true, // 是否是时效队列，true-是，false-否
"activeTime": "2021-03-20 16:56:47", // 消息有效时间
"consumeType": -1, // 消费渠道 -1.未消费 1.bot 2.factory 3.topic
"data": "{\"2333\": \"23333\"}", // 数据
"gmtCreated": "2021-03-20 16:56:50", // 创建时间
"gmtModified": "2021-03-20 16:56:57" // 修改时间
},
{
"queueMessageID": "21",
"queueID": "9",
"queueUUID": "4043806a0dfe480bbdcbae4931847eba",
"source": "1",
"status": -1,
"productTime": "2021-03-20 16:56:46",
"consumeTime": null,
"isExpire": true,
"activeTime": "2021-03-20 16:56:47",
"consumeType": -1,
"data": "{\"2333\": \"23333\"}",
"gmtCreated": "2021-03-20 16:56:49",
"gmtModified": "2021-03-20 16:56:57"
}
]
}
八、根据消息ID查询消息详情
接口说明
该接口是为了提供队列管理功能，队列根据消息ID查询详情所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue-message/select-queue-message-by-id
HTTP method: POST
Content-Type: application/json
请求样例
{
"queueMessageID": 1386216671115882498, // 队列消息ID
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueMessageID |
String |
是 |
队列消息ID |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueMessageID": "1386216671115882498", // 队列消息ID
"queueID": "1382944454144094209", // 队列ID
"queueUUID": "35911eb4cbf5486c85f84c0e3333e69b", // 队列UUID
"source": "default", // 消息来源
"status": -1, // 消息状态:-1-已过期 1-未消费 2-已消费
"productTime": "2021-04-25 15:13:04", // 入队时间
"consumeTime": "2021-04-25 15:13:04", // 消费时间
"isExpire": true, // 是否是时效队列，true-是，false-否
"activeTime": "2021-04-25 15:17:04", // 消息有效时间
"consumeType": -1, // 消费渠道 -1.未消费 1.bot 2.factory 3.topic
"data": "1234", // 数据
"gmtCreated": "2021-04-25 15:13:08", // 创建时间
"gmtModified": "2021-04-25 15:16:09" // 修改时间
}
}
九、根据队列UUID获取topic地址
接口说明
该接口是为了提供队列管理功能，根据队列UUID获取topic地址所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/queue/select-queue-topic-address
HTTP method: POST
Content-Type: application/json
请求样例
{
"uuid": "35911eb4cbf5486c85f84c0e3333e69b" // 队列UUID
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
uuid |
String |
是 |
队列UUID |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"productAddress": "http:127.0.0.1:8084/openAPI/queue/product/queue-UUID/68e96c61e7904727ba746feead596320", // 生产者地址
"consumerAddress": "http:127.0.0.1:8084/openAPI/queue/consume/queue-UUID/68e96c61e7904727ba746feead59632" // 消费者地址
}
}
十、校验当前队列名称是否有效
接口说明
该接口是为了校验当前队列名称是否有效的功能, 校验名称有效则返回对应uuid
URL: https://z-commander-api.ai-indeed.com/openAPI/queue/check
HTTP method: GET
请求样例
https://z-commander-api.ai-indeed.com/openAPI/queue/check?queueName=123
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueName |
String |
是 |
队列名称 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"tenantId": "testDemoTenantId", // 对应租户id
"queueUuid": "testDemoUuid" // 当前队列的uuid
}
}
十一、通过队列uuid进行消费队列
接口说明
该接口是为了通过队列uuid进行消费队列
URL: https://z-commander-api.ai-indeed.com/openAPI/queue/consume/queue-UUID/{queueUuid}
HTTP method: GET
请求样例
https://z-commander-api.ai-indeed.com/openAPI/queue/consume/queue-UUID/{queueUuid}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
queueUuid |
String |
是 |
队列uuid |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueMessageId": "123", // 队列id
"queueUuid": "testDemoUuid", // 当前队列的uuid
"data":"testDemo"// 对应数据
}
}
十二、通过队列名称进行生产队列
接口说明
该接口是为了通过队列名称进行生产队列
URL: https://z-commander-api.ai-indeed.com/openAPI/queue/product/queue-name/{queueName}
HTTP method: POST
Content-Type: application/json
请求样例
https://z-commander-api.ai-indeed.com/openAPI/queue/product/queue-name/测试队列名
{
"data": "{}", // json字符串
"source": "openapi测试" // 来源
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
data |
String |
是 |
json字符串 |
|
source |
String |
否 |
来源 |
路径参数
|
参数 |
类型 |
必填 |
说明 |
|
queueName |
String |
是 |
队列名称 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueMessageId": "123" // 队列id
}
}
十三、通过队列uuid进行生产队列
接口说明
该接口是为了通过队列uuid进行生产队列
URL: https://z-commander-api.ai-indeed.com/openAPI/queue/product/queue-UUID/{queueUuid}
HTTP method: POST
Content-Type: application/json
请求样例
https://z-commander-api.ai-indeed.com/openAPI/queue/product/queue-UUID/testQueueUuid
{
"data": "{}", // json字符串
"source": "openapi测试" // 来源
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
data |
String |
是 |
json字符串 |
|
source |
String |
否 |
来源 |
路径参数
|
参数 |
类型 |
必填 |
说明 |
|
queueUuid |
String |
是 |
队列uuid |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"queueMessageId": "123" // 队列id
}
}
