上传批量任务文件 - UploadBatchTaskFile
功能介绍
应用服务器可调用此接口上传批量任务文件,用于创建批量任务。当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备任务的文件上传。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
iotda:batchtaskfiles:create
Write
-
g:EnterpriseProjectId
-
-
URI
POST /v5/iot/{project_id}/batchtask-files
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数说明:项目ID。获取方法请参见 获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Instance-Id | 否 | String | 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file | 是 | File | 参数说明:上传批量任务文件。 取值范围:当前仅支持xlsx/xls文件格式,且文件最大行数为100000行。 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| file_id | String | 上传的批量任务文件ID,由平台自动生成。 |
| file_name | String | 上传的批量任务文件名称。 |
| 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 |
错误码
请参见错误码。