Skip to content

创建产品/设备订阅

接口地址:/v2/quecrule/{version}/openapi/subscribe/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

创建订阅

请求示例:

javascript
{
  "dataLevel": 1,
  "deviceKey": "dk",
  "msgTypes": [
    1
  ],
  "productKey": "pk",
  "queueName": "queueName",
  "subscribeName": "test"
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
subscribeDTO订阅信息bodytrueOpenApiSubscribeDTOOpenApiSubscribeDTO
  dataLevel数据等级, 1产品2设备trueinteger(int32)
  deviceKey设备DKfalsestring
  msgTypes消息类型:\n透传产品支持以下类型:\n1-设备上下线事件\n2-设备和模组状态\n3-设备上行数据\n4-设备下行数据\n5-设备命令响应\n12-设备定位原始信息\n13-设备定位信息\n14-设备绑定变更信息\n15-设备信息变更\n物模型产品支持以下类型:\n1-设备上下线事件\n2-设备和模组状态\n3-设备上行透传数据\n4-设备下行透传数据\n5-设备命令响应\n6-物模型属性信息\n7-物模型事件上报-信息\n8-物模型事件上报-告警\n9-物模型事件上报-故障\n10-物模型服务调用日志\n12-设备定位原始信息\n13-设备定位信息\n14-设备绑定变更信息\n15-设备信息变更truearrayinteger
  productKey产品PKtruestring
  queueName队列名称truestring
  subscribeName订阅名,最大长度128字符, 支持中文、大小写英文字符串(区分大小写)、数字、下划线(_)、中划线(-)、不支持斜杠(/)、空格等其他字符truestring
version当前版本,可用值:r1pathtruestring

响应状态:

状态码说明schema
200OKActionResultOfOpenApiSubscribeIdDTO
201Created
401Unauthorized
403Forbidden
404Not Found
16002The queue name does not exist
16018The number of subscription rules is out of limit
16024The message subscription is not enabled, please go to the SaaS development Guide to apply for enabling
50000service exception
50004param null or empty
50005param check error
70017The product does not exist
70060Permission Denied
70130The device does not exist
91004token incorrect
91005doesn't have permission

响应参数:

参数名称参数说明类型schema
code返回码integer(int32)integer(int32)
data对象OpenApiSubscribeIdDTOOpenApiSubscribeIdDTO
  subscribeId订阅IDinteger(int64)
msg提示信息string
pageNum当前页数integer(int32)integer(int32)
pageSize每页数量integer(int32)integer(int32)
pages总页数integer(int32)integer(int32)
total总数integer(int32)integer(int32)

响应示例:

javascript
{
	"code": 0,
	"data": {
		"subscribeId": 1
	},
	"msg": "",
	"pageNum": 0,
	"pageSize": 0,
	"pages": 0,
	"total": 0
}