CreateProductTopic - 阿里云物联网平台

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。

说明单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateProductTopic	系统规定参数。取值：CreateProductTopic。
Operation	String	是	PUB	设备对该Topic类的操作权限，取值： SUB：订阅。 PUB：发布。 ALL：发布和订阅。
ProductKey	String	是	aldDEin****	要创建Topic类所属产品的ProductKey。
TopicShortName	String	是	submit	设置Topic类的自定义类目名称。 Topic格式必须以`/`进行分层，区分每个类目。类目命名只能包含字母、数字和下划线（_），每级类目不能为空。说明 Operation为SUB（订阅）时，才可以使用通配符`+`和`#`自定义Topic类，以便设备实现批量订阅Topic。通配符使用方法请参见带通配符的自定义Topic 。对于云网关产品，Topic类完全由用户自定义输入。支持使用`${deviceName}`通配DeviceName。对于非云网关产品，自定义Topic类前三个类目已固定为`/${productKey}/${deviceName}/user/`，定义TopicShortName将Topic类填充完整。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无ID值，则无需传入。实例的更多信息，请参见实例概述。
Desc	String	否	submit a test topic	Topic类的描述信息。长度限制为100字符（一个中文汉字占一个字符）。
EnableProxySubscribe	Boolean	否	false	Operation为SUB（订阅）或ALL（发布和订阅），可开启代理订阅。取值： true：开启。 false：不开启。开启代理订阅后，设备与物联网平台建连时，物联网平台查询已开启代理订阅的Topic，帮助设备完成订阅。
Codec	String	否	compress	标准型和尊享型企业版实例下，可开启自定义Topic数据压缩或解压缩。取值： compress：压缩。 decompress：解压缩。数据压缩功能详细内容，请参见数据压缩。重要 TopicShortName传入通配符（`+`和`#`）时，不可同时传入Codec。如果创建通配Topic类的同时，开启了数据压缩或解压缩功能，调用本接口创建该Topic类会失败。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
TopicId	Long	10000	调用成功时，物联网平台为新建的Topic类生成的Topic ID。说明请妥善保管该信息。在调用与该Topic类相关的接口时，您可能需要提供对应的Topic ID。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<公共请求参数>

正常返回示例

XML格式

<CreateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
      <TopicId>10000</TopicId>
</CreateProductTopicResponse>

JSON格式

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

错误码

访问错误中心查看更多错误码。