Skip to content

Query Subscription Details

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

Request Method:GET

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

Response Data Type:*/*

API Description:View subscription details

Request Parameters:

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

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfOpenApiSubscribeDetailDTO
401Unauthorized
403Forbidden
404Not Found
16011The subscription rule does not exist
50000Service exception
50005Parameter check error
70060Permission Denied
91004Token incorrect
91005Doesn't have permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeinteger(int32)integer(int32)
dataObjectOpenApiSubscribeDetailDTOOpenApiSubscribeDetailDTO
  createTimeCreation timestring(date-time)
  dataLevelData level, 1-Product 2-Device 4-Enterprise user 5-End user domaininteger(int32)
  deviceKeyDevice DKstring
  deviceNameDevice namestring
  endUserDomainEnd user domainstring
  msgTypeMessage typestring
  productKeyProduct PKstring
  productNameProduct namestring
  queueIdQueue IDinteger(int64)
  queueNameQueue namestring
  statusSubscription statusinteger(int32)
  subscribeIdSubscription IDinteger(int64)
  subscribeNameSubscription namestring
  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": 1623814212000,
		"dataLevel": 0,
		"deviceKey": "",
		"deviceName": "",
		"endUserDomain": "",
		"msgType": "",
		"productKey": "",
		"productName": "",
		"queueId": 0,
		"queueName": "",
		"status": 0,
		"subscribeId": 0,
		"subscribeName": "",
		"updateTime": 1623814212000,
		"userId": 0
	},
	"msg": "",
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"total": 0
}