BatchPub_物联网平台_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.

接口说明

使用说明

QPS 限制

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

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

流控信息

请求速率为100/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:BatchPub
Create
全部资源
*

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

要发送消息的产品 ProductKey

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
Qosinteger<int32>

指定消息的发送方式。取值:展开详情

示例值:0枚举值:01
TopicShortNamestring

自定义 Topic 的后缀。展开详情

示例值:get参考取值来源:
    CreateProductTopic
    QueryProductTopic
MessageContentstring

要发送的消息主体。最大报文 256 KB。展开详情

示例值:eyJ0ZXN0IjoidGFzayBiYXRjaHB1YiBicm9hZGNhc3QifQ==
TopicTemplateNamestring
ResponseTopicTemplateNamestring
CorrelationDatastring
PayloadFormatIndicatorinteger<int32>
ContentTypestring
MessageExpiryIntervalinteger<int64>
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
Retainedboolean
DeviceNamearray<string>

要接收消息的设备名称。展开详情

示例值:newdevice1子级条数 <= 100
UserProparray<object>
子级条数 <= 20

请求说明

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

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

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

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

表示是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例

向设备端发布topic消息
2022-06-28