Skip to content

Query Queue List

API Address:/v2/quecrule/{version}/openapi/queue/list

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Queue list

Request Example:

javascript
{
  "pageNum": 1,
  "pageSize": 10,
  "queueName": "testQueue",
  "status": 1
}

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
queueQueryDTOQuery parametersbodytrueOpenApiQueryQueueDTOOpenApiQueryQueueDTO
  pageNumPage number, starting from 1falseinteger(int32)
  pageSizeNumber of items per page, range 1~100falseinteger(int32)
  queueNameQueue namefalsestring
  statusQueue status, 0-Not enabled 1-Enabled 2-Disabled, blank for allfalseinteger(int32)
versionCurrent version, valid value:r1pathtruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfListOfQbQueue
201Created
401Unauthorized
403Forbidden
404Not Found
50000Service exception
50005Parameter check error
91004Token incorrect
91005Doesn't have permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeinteger(int32)integer(int32)
dataObjectarrayQbQueue
  createTimeCreation timestring(date-time)
  entUserIdEnterprise user IDinteger(int64)
  idIDinteger(int64)
  isFreeIs free queue: 0:No, 1:Yesinteger(int32)
  metadataQueue metadatastring
  queueDescQueue descriptionstring
  queueNameQueue namestring
  statusQueue statusinteger(int32)
  updateTimeUpdate timestring(date-time)
  userIdUser IDinteger(int64)
msgPrompt messagestring
pageNumCurrent page numberinteger(int32)integer(int32)
pageSizeItems per pageinteger(int32)integer(int32)
pagesTotal pagesinteger(int32)integer(int32)
totalTotal countinteger(int32)integer(int32)

Response Example:

javascript
{
    "code": 0,
        "data": [
        {
            "createTime": "1730871805372",
            "entUserId": 1358403955870720,
            "id": 6611,
            "isFree": 0,
            "metadata": "",
            "queueDesc": "desc",
            "queueName": "a.1358403955870720.testQueue",
            "status": 1,
            "updateTime": null,
            "userId": 1358403955870720
        }
    ],
        "msg": "",
        "pageNum": 1,
        "pageSize": 10,
        "pages": 1,
        "total": 1
}