调用该接口更新指定的产品自定义Topic类。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | UpdateProductTopic | 系统规定参数。取值:UpdateProductTopic。 |
Operation | String | 是 | PUB | 设备对该Topic类的操作权限,取值:
|
TopicId | String | 是 | 821**** | 要修改的Topic类的ID。 调用CreateProductTopic接口创建自定义Topic类成功后,返回的TopicId。 |
TopicShortName | String | 是 | resubmit | 设置Topic类的自定义类目名称。Topic类默认包含_productKey_和_deviceName_两级类目,类目间以正斜线(/)分隔,其格式为: 说明 每级类目的名称只能包含字母、数字和下划线(_),且不能为空。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
Desc | String | 否 | resubmit a test topic | Topic类的描述信息。长度限制为100字符(一个汉字占一个字符)。 |
EnableProxySubscribe | Boolean | 否 | false | Operation为SUB(订阅)或ALL(发布和订阅),可开启代理订阅。 取值:
开启代理订阅后,设备与物联网平台建连时,物联网平台查询已开启代理订阅的Topic,帮助设备完成订阅。 |
Codec | String | 否 | compress | 标准型和尊享型企业版实例下,可开启自定义Topic数据压缩或解压缩。 取值:
数据压缩功能详细内容,请参见数据压缩。 重要 TopicShortName传入通配符( + 和# )时,不可同时传入Codec。如果创建通配Topic类的同时,开启了数据压缩或解压缩功能,调用本接口创建该Topic类会失败。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | FCC27691-9151-4B93-9622-9C90F30542EC | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTopic
&TopicId=821****
&TopicShortName=resubmit
&Operation=PUB
&Desc=resubmit a test topic
&<公共请求参数>
正常返回示例
XML
格式
<UpdateProductTopicResponse>
<RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
<Success>true</Success>
</UpdateProductTopicResponse>
JSON
格式
{
"RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
"Success":true
}