CreateProductTopic
調(diào)用該接口為指定產(chǎn)品創(chuàng)建自定義Topic類。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為1。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | CreateProductTopic | 系統(tǒng)規(guī)定參數(shù)。取值:CreateProductTopic。 |
Operation | String | 是 | PUB | 設(shè)備對該Topic類的操作權(quán)限,取值:
|
ProductKey | String | 是 | aldDEin**** | 要創(chuàng)建Topic類所屬產(chǎn)品的ProductKey。 |
TopicShortName | String | 是 | submit | 設(shè)置Topic類的自定義類目名稱。 Topic格式必須以
|
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
Desc | String | 否 | submit a test topic | Topic類的描述信息。長度限制為100字符(一個中文漢字占一個字符)。 |
EnableProxySubscribe | Boolean | 否 | false | Operation為SUB(訂閱)或ALL(發(fā)布和訂閱),可開啟代理訂閱。 取值:
開啟代理訂閱后,設(shè)備與物聯(lián)網(wǎng)平臺建連時,物聯(lián)網(wǎng)平臺查詢已開啟代理訂閱的Topic,幫助設(shè)備完成訂閱。 |
Codec | String | 否 | compress | 標準型和尊享型企業(yè)版實例下,可開啟自定義Topic數(shù)據(jù)壓縮或解壓縮。 取值:
數(shù)據(jù)壓縮功能詳細內(nèi)容,請參見數(shù)據(jù)壓縮。 重要 TopicShortName傳入通配符( + 和# )時,不可同時傳入Codec。如果創(chuàng)建通配Topic類的同時,開啟了數(shù)據(jù)壓縮或解壓縮功能,調(diào)用本接口創(chuàng)建該Topic類會失敗。
|
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調(diào)用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | FCC27691-9151-4B93-9622-9C90F30542EC | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
TopicId | Long | 10000 | 調(diào)用成功時,物聯(lián)網(wǎng)平臺為新建的Topic類生成的Topic ID。 說明 請妥善保管該信息。在調(diào)用與該Topic類相關(guān)的接口時,您可能需要提供對應(yīng)的Topic ID。 |
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<公共請求參數(shù)>
正常返回示例
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
}