CreateDownloadDataJob_物联网平台_API文档

2018-01-20

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

该任务等同于在控制台创建的数据下载任务，用户可在对应数据表的导出管理页面查看此次下载任务的日志，并下载文件。
通过该接口创建下载任务会增加 AMQP 消息推送，其中consumerGroupId请选用dop_aliyun_group_name，消息内容包含此次下载任务的执行状态，用户可根据此状态，配合 GetDownloadFile 接口获取文件下载地址或查看下载任务的异常信息。

使用限制

同一数据实例下，每次只能创建 1 个下载任务。待上一个任务执行完成后才能创建新的下载任务，否则会提示超过下载任务数限制异常。
单次下载数据时间范围最多为 3 天。
1 天内只能创建 3 个下载任务，RAM 用户共享阿里云账号配额。

流控信息

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

授权信息

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

请求参数

字段名称	字段详情
IotInstanceIdstring	实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。展开详情示例值:iot-cn-npk1u******
TableNamestring	需下载的表名称。示例值:product_info
DownloadDataTypestring	下载对象的类型，暂只支持 TABLE。示例值:TABLE
FileConfigobject	下载文件设置。给下载文件设置一个名称（fileName），可自定义，若 fileName 不传则默认生成一个文件名。示例值:{"fileName":"fileName01"}
StartTimeinteger<int64>	时间范围，查询数据的开始时间。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1658332800000
EndTimeinteger<int64>	时间范围，查询数据的结束时间。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1658406464534

请求说明

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

返回参数

字段名称	字段详情
Codestring	调用失败时，返回的错误码。更多信息，请参见错误码。示例值:200
ErrorMessagestring	调用失败时，返回的错误信息。示例值:no authorization.
RequestIdstring	请求 ID，阿里云为该请求生成的唯一标识符。示例值:4D6D7F71-1C94-4160-8511-EFF4B8F0643F
Successboolean	是否调用成功。展开详情示例值:true
Dataobject	请求的返回结果。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	iot.dap.insight.noAuthorization	no authorization.	诊断
400	iot.dap.insight.requestParamError	request param error.	诊断
400	iot.dap.insight.serverError	server hsf error please try later	诊断
400	iot.dap.insight.queryTimeMoreThanQueryDays	The query time range exceeded the allowed time range	诊断
400	iot.dap.insight.processDownloadJobMoreConcurrenceCount	the number of concurrent download tasks in progress exceeds the upper limit	诊断
400	iot.dap.insight.downloadTimesUpperLimit	the number of current job downloaded tasks exceeded the upper limit	诊断
400	iot.dap.insight.downloadTaskNumUpperLimit	the number of downloaded tasks exceeded the upper limit	诊断

变更历史

暂无变更历史

相关示例

阿里云IoT-数据服务-数据下载任务

2023-03-15