UpdateTopicConfig
調(diào)用該接口可設(shè)置自定義Topic的操作權(quán)限,及是否支持消息廣播、是否開啟代理訂閱和是否開啟壓縮或解壓縮。
使用說明
一個自定義Topic廣播消息時,最多可被1,000個設(shè)備訂閱。若后續(xù)需要新增更多設(shè)備訂閱該自定義Topic的廣播消息,可使用MQTT 5.0版本通信協(xié)議進(jìn)行通信,通過設(shè)置自定義Topic支持消息廣播和設(shè)置自定義Topic消息為保留消息來實(shí)現(xiàn)。
具體步驟為:
1. 調(diào)用本接口設(shè)置指定的自定義Topic(例如:/broadcast/a1Q5XoY****/test
)支持消息廣播,即EnableBroadcast設(shè)置為true。
2. 調(diào)用Pub接口向該自定義Topic(例如:/broadcast/a1Q5XoY****/test
)發(fā)布廣播消息,并設(shè)置為保留消息,即Retained設(shè)置為true。
3. 調(diào)用SubscribeTopic接口,新增設(shè)備訂閱該自定義Topic(例如:/broadcast/a1Q5XoY****/test
),設(shè)備即可收到上一步向該自定義Topic發(fā)送的保留消息。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為100。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | UpdateTopicConfig | 系統(tǒng)規(guī)定參數(shù)。取值:UpdateTopicConfig。 |
ProductKey | String | 是 | a1Q5XoY**** | 要接收消息的設(shè)備所屬產(chǎn)品的ProductKey。 |
TopicFullName | String | 是 | /broadcast/a1Q5XoY****/test | 自定義Topic。
重要 對于要廣播消息的自定義Topic:
|
IotInstanceId | String | 否 | iot-0pp1n8t**** | 實(shí)例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實(shí)例概覽頁面,查看當(dāng)前實(shí)例的ID。 重要
實(shí)例的更多信息,請參見實(shí)例概述。 |
EnableBroadcast | Boolean | 否 | true | 是否支持消息廣播。
|
Operation | String | 否 | SUB | 設(shè)備對該Topic類的操作權(quán)限,取值:
|
EnableProxySubscribe | Boolean | 否 | false | Operation為SUB(訂閱)或ALL(發(fā)布和訂閱),可開啟代理訂閱。 取值:
開啟代理訂閱后,設(shè)備與物聯(lián)網(wǎng)平臺建連時,物聯(lián)網(wǎng)平臺查詢已開啟代理訂閱的Topic,幫助設(shè)備完成訂閱。 |
Codec | String | 否 | compress | 標(biāo)準(zhǔn)型和尊享型企業(yè)版實(shí)例下,可開啟自定義Topic數(shù)據(jù)壓縮或解壓縮。 取值:
數(shù)據(jù)壓縮功能詳細(xì)內(nèi)容,請參見數(shù)據(jù)壓縮。 |
Description | String | 否 | submit a test topic | Topic的描述信息。長度限制為100字符(一個中文漢字占一個字符)。 |
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調(diào)用失敗時,返回錯誤碼。詳細(xì)信息,請參見下文錯誤碼。 |
Message | String | 系統(tǒng)異常 | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請求生成的唯一標(biāo)識符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateTopicConfig
&EnableBroadcast=true
&ProductKey=a1Q5XoY****
&TopicFullName=/broadcast/a1Q5XoY****/test
&IotInstanceId=iot-0pp1n8t****
&<公共請求參數(shù)>
正常返回示例
XML
格式
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Code/>
<Success>true</Success>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Code": "",
"Success": true
}