更新时间:2024-05-29 GMT+08:00

上传批量任务文件

功能介绍

应用服务器可调用此接口上传批量任务文件,用于创建批量任务。当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备任务的文件上传。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/batchtask-files

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

最小长度:1

最大长度:36

表3 FormData参数

参数

是否必选

参数类型

描述

file

File

参数说明:上传批量任务文件。 取值范围:当前仅支持xlsx/xls文件格式,且文件最大行数为100000行。

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

file_id

String

上传的批量任务文件ID,由平台自动生成。

file_name

String

上传的批量任务文件名称。

最小长度:1

最大长度:60

upload_time

String

在物联网平台上传文件的时间。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

请求示例

上传批量任务文件。

POST https://{endpoint}/v5/iot/{project_id}/batchtask-files

响应示例

状态码: 201

Created

{
  "file_id" : "0c3c77dd-42a2-4309-9e10-da2e8bf64ac3",
  "file_name" : "BatchCreateDevices_test01.xlsx",
  "upload_time" : "20200617T081608Z"
}

状态码

状态码

描述

201

Created

400

BAD REQUEST

401

Unauthorized

403

FORBIDDEN

500

Internal Server Error

错误码

请参见错误码