Skip to content

Update Subscription

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

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

API Description:Update subscription

Request Example:

javascript
{
  "msgTypes": [
    1
  ],
  "queueName": "",
  "subscribeId": 0,
  "subscribeName": ""
}

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
subscribeDTOSubscription informationbodytrueOpenApiSubscribeUpdateDTOOpenApiSubscribeUpdateDTO
  msgTypesMessage types\nProduct/Device level subscription:\nTransparent transmission products support the following types:\n1-Device online/offline events\n2-Device and module status\n3-Device uplink data\n4-Device downlink data\n5-Device command response\n12-Device location original information\n13-Device location information\n14-Device binding change information\n15-Device information change\nThing model products support the following types:\n1-Device online/offline events\n2-Device and module status\n5-Device command response\n6-Thing model property information\n7-Thing model event report-information\n8-Thing model event report-alert\n9-Thing model event report-fault\n10-Thing model service call log\n12-Device location original information\n13-Device location information\n14-Device binding change information\n15-Device information change\nUser level subscription:\n101-Product information change\n102-Device information change\n103-Thing model publication information change\nSaaS user level subscription:\n101-Product information change\n102-Device information change\n103-Thing model publication information change\n104-Product authorization information\nEnd user domain level subscription:\n201-End user add/delete/modifyfalsearrayinteger
  queueNameQueue namefalsestring
  subscribeIdSubscription IDtrueinteger(int64)
  subscribeNameSubscription name, maximum length 128 characters, supports Chinese, uppercase and lowercase English characters (case-sensitive), numbers, underscores (_), hyphens (-), does not support slashes (/), spaces, or other charactersfalsestring
versionCurrent version, valid value:r1pathtruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfobject
201Created
401Unauthorized
403Forbidden
404Not Found
16002The queue name does not exist
16022The running subscription rule does not allow modification
50000Service exception
50004Parameter null or empty
50005Parameter check error
70060Permission Denied
91004Token incorrect
91005Doesn't have permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeinteger(int32)integer(int32)
dataObjectobject
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": {},
	"msg": "",
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"total": 0
}