调用该接口向物联网平台批量导入外部数据。通过此API导入物联网平台的数据,称为API数据源的数据。您可将本地或其他平台的数据批量上传至物联网平台,用于数据的分析和处理。
使用限制
一次调用最多可批量写入100条记录。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为3。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchAddDataForApiSource | 系统规定参数。取值:BatchAddDataForApiSource。 |
ApiId | String | 是 | cxatswiniekxw*** | API数据源ID,即API ID。您可在物联网平台控制台的数据服务 > 数据接入 > API数据源页面,查看API数据源的API ID。 API数据源的更多信息,请参见配置API数据源。 |
ContentList | Json | 是 | [{"key":"value1","ts":1637658286000},{"key":"value2","ts":1637658287000}] | 批量上传到物联网平台的数据内容,为JSON列表格式。
|
IotInstanceId | String | 是 | iot-0pp1n***** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Map | {"count":2,"hasNext":false,"items":[{"key":"value1","ts":1637658286000,"id":1234567890},{"key":"value2","ts":1637658287000,"id":1234567891}],"pageNum":1,"pageSize":2} | 上传到物联网平台的数据内容以及数据ID。数据ID在id字段中获取。 |
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | BB71E443-4447-4024-A000-EDE09922891E | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchAddDataForApiSource
&ApiId=cxatswiniekxw***
&ContentList=[{"key":"value1","ts":1637658286000},{"key":"value2","ts":1637658287000}]
&IotInstanceId=iot-0pp1n*****
&<公共请求参数>
正常返回示例
XML
格式
<BatchAddDataForApiSourceResponse>
<RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
<Data>{"count":2,"hasNext":false,"items":[{"key":"value1","ts":1637658286000,"id":1234567890},{"key":"value2","ts":1637658287000,"id":1234567891}],"pageNum":1,"pageSize":2}</Data>
<Code></Code>
<Success>true</Success>
</BatchAddDataForApiSourceResponse>
JSON
格式
{
"RequestId": "BB71E443-4447-4024-A000-EDE09922891E",
"Data": "{\"count\":2,\"hasNext\":false,\"items\":[{\"key\":\"value1\",\"ts\":1637658286000,\"id\":1234567890},{\"key\":\"value2\",\"ts\":1637658287000,\"id\":1234567891}],\"pageNum\":1,\"pageSize\":2}",
"Code": "",
"Success": true
}