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

限制说明

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

说明 子账号共享主账号配额。

调试

您可以在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类默认包含_productKey_和_deviceName_两级类目,类目间以正斜线(/)分隔,其格式为:productKey/deviceName/topicShortName

说明 每级类目的名称只能包含字母、数字和下划线(_),且不能为空。
IotInstanceId String iot_instc_pu****_c*-v64********

公共实例不传此参数;您购买的实例需传入实例ID。

Desc String submit a test topic

Topic类的描述信息。长度限制为100字符(一个汉字占一个字符)。

调用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
}