Skip to content

Query Queue Details

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

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description:Queue details

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
queueIdQueue IDquerytrueinteger(int64)
versionCurrent version, valid value:r1pathtruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfQueueDetailDTO
401Unauthorized
403Forbidden
404Not Found
16002The queue name does not exist
50000Service exception
50005Parameter check error
91004Token incorrect
91005Doesn't have permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeinteger(int32)integer(int32)
dataObjectQueueDetailDTOQueueDetailDTO
  connectUrlConnection URLstring
  consumeRateConsumption ratestring
  createTimeCreation timestring(date-time)
  msgNumMessage countinteger(int64)
  msgSizeMessage backlog sizestring
  queueDescQueue descriptionstring
  queueIdQueue IDinteger(int64)
  queueNameQueue namestring
  statusQueue statusinteger(int32)
  updateTimeUpdate timestring(date-time)
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": {
		"connectUrl": "",
		"consumeRate": "",
		"createTime": 1623814212000,
		"msgNum": 0,
		"msgSize": "",
		"queueDesc": "",
		"queueId": 0,
		"queueName": "",
		"status": 0,
		"updateTime": 1623814212000
	},
	"msg": "",
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"total": 0
}