UpdateProductTopic - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	UpdateProductTopic	系統規定參數。取值：UpdateProductTopic。
Operation	String	是	PUB	裝置對該Topic類的操作許可權，取值： SUB：訂閱。 PUB：發布。 ALL：發布和訂閱。
TopicId	String	是	821****	要修改的Topic類的ID。調用CreateProductTopic介面建立自訂Topic類成功後，返回的TopicId。
TopicShortName	String	是	resubmit	設定Topic類的自訂類目名稱。Topic類預設包含_productKey_和_deviceName_兩級類目，類目間以正斜線（/）分隔，其格式為：`productKey/deviceName/topicShortName`。說明每級類目的名稱只能包含字母、數字和底線（_），且不可為空。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
Desc	String	否	resubmit 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：調用失敗。

樣本

請求樣本

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。