# CreateProductTopic

调用该接口为指定产品创建自定义Topic类。

# 请求参数

名称 类型 是否必选 示例值 描述
Action String CreateProductTopic 系统规定参数。取值:CreateProductTopic。
Operation String PUB 设备对该Topic类的操作权限,取值:PUB:发布。SUB:订阅。ALL:发布和订阅。
ProductKey String aldDEin**** 要创建Topic类所属产品的ProductKey。
TopicShortName String resubmit 设置Topic类的自定义类目名称。Topic格式必须以/进行分层,区分每个类目。类目命名只能包含字母、数字和下划线(_),每级类目不能为空。自定义Topic类前三个类目已固定为/${productKey}/${deviceName}/user/,定义TopicShortName将Topic类填充完整。
IotInstanceId String 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。
Desc String submit a test topic Topic类的描述信息。长度限制为100字符(一个汉字占一个字符)。
EnableProxySubscribe Boolean false Operation为SUB(订阅)或ALL(发布和订阅),可开启代理订阅。取值:true:开启(默认)。false:不开启。开启代理订阅后,设备与物联网平台建连时,物联网平台查询已开启代理订阅的Topic,帮助设备完成订阅。

注意: 当操作权限(Operation)为ALL且开启代理订阅(EnableProxySubscribe=true)时

  • 当设备侧使用MQTT 3.1/3.1.1协议连接平台,设备使用权限为ALL的topic发布消息时,设备会接收到自身发布的消息内容;
  • 当设备侧使用MQTT 5.0协议连接平台,设备使用权限为ALL的topic发布消息时,设备不会接收到自身发布的消息内容。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时,返回的错误码。
ErrorMessage String 系统异常 调用失败时,返回的出错信息。
RequestId String olmM8Mc9H3DcP7y4kGswzCG6lKHSAndq 平台为该请求生成的唯一标识符。
Success Boolean true 是否调用成功。
true:表示调用成功。
false:表示调用失败。
TopicId String 7228157********* 调用成功时,物联网平台为新建的Topic类生成的Topic ID。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&EnableProxySubscribe=false
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
  <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
  <Success>true</Success>
  <TopicId>7228157*********</TopicId>
</xml>

JSON格式

{
  "RequestId": "FCC27691-9151-4B93-9622-9C90F30542EC",
  "Success": true,
  "TopicId": "7228157*********"
}