UpdateTopicConfig_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

一个自定义 Topic 广播消息时,最多可被 1,000 个设备订阅。若后续需要新增更多设备订阅该自定义 Topic 的广播消息,可使用 MQTT 5.0 版本通信协议进行通信,通过设置自定义 Topic 支持保留消息广播和设置自定义 Topic 消息为保留消息来实现。 具体步骤为:

  1. 调用本接口设置指定的自定义 Topic(例如:/broadcast/a1Q5XoY****/test)支持保留消息广播,即 EnableBroadcast 设置为 true
  2. 调用 Pub 接口向该自定义 Topic(例如:/broadcast/a1Q5XoY****/test)发布广播消息,并设置为保留消息,即 Retained 设置为 true
  3. 调用 SubscribeTopic 接口,新增设备订阅该自定义 Topic(例如:/broadcast/a1Q5XoY****/test),设备即可收到上一步向该自定义 Topic 发送的保留消息。

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 100。

说明 RAM 用户共享阿里云账号配额。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot-0pp1n8t****
ProductKeystring

要接收消息的设备所属产品的 ProductKey

示例值:a1Q5XoY****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
EnableBroadcastboolean

是否支持保留消息广播。展开详情

示例值:true
EnableProxySubscribeboolean
Codecstring
Operationstring
TopicFullNamestring

要广播消息的自定义 Topic。展开详情

示例值:/broadcast/a1Q5XoY****/test
Descriptionstring

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回错误码。详细信息,请参见错误码

示例值:iot.system.SystemException
Messagestring
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.message.broker.ParamCheckError
Param check error.诊断
400
iot.message.broker.ProductCheckError
Product check error.诊断
400
iot.message.broker.TopicConfigNumExceed
Topic config num exceed.诊断
400
iot.message.broker.SystemError
System error.诊断
400
iot.messagebroker.InvalidPubTopicFormat
The pub topic cannot contain wildcard character.诊断
400
iot.messagebroker.InvalidOperationWithBroadcast
The operation must be sub when enable broadcast.诊断
400
iot.messagebroker.InvalidTopicWithBroadcast
The topic cannot contain wildcard character when enable broadcast.诊断
400
iot.messagebroker.InvalidOperationWithProxySubscribe
Operation must be sub or all when enable proxy subscribe.诊断
400
iot.messagebroker.InvalidTopicWithProxySubscribe
Topic cannot contain wildcard character when enable proxy subscribe.诊断
400
iot.messagebroker.InvalidTopicWithCodec
Topic cannot contain wildcard when enable codec.诊断
400
iot.messagebroker.InvalidInstanceWithCodec
Only connect instance support codec.诊断

变更历史

暂无变更历史