調用該接口更新指定的產品自定義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
}