CreateDownloadDataJob_物联网平台(IoT)-阿里云帮助中心

使用说明

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

使用限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateDownloadDataJob	系统规定参数。取值：CreateDownloadDataJob。
IotInstanceId	String	否	iot-cn-npk1u******	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无ID值，则无需传入。实例的更多信息，请参见实例概述。
TableName	String	是	product_info	需下载的表名称。
DownloadDataType	String	是	TABLE	下载对象的类型，暂只支持TABLE。
FileConfig	Map	否	{"fileName":"fileName01"}	下载文件设置。给下载文件设置一个名称（fileName），可自定义，若fileName不传则默认生成一个文件名。
StartTime	Long	否	1658332800000	时间范围，查询数据的开始时间。
EndTime	Long	否	1658406464534	时间范围，查询数据的结束时间。

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

返回数据

名称	类型	示例值	描述
Code	String	200	调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage	String	no authorization.	调用失败时，返回的错误信息。
RequestId	String	4D6D7F71-1C94-4160-8511-EFF4B8F0643F	请求ID，阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
Data	Object		请求的返回结果。
Status	Integer	-1	下载任务的执行状态。 -1：初始化中。 0：运行中。 1：执行成功。 2：执行失败。 3：已提交，等待中。 4：已取消。
LongJobId	String	62d949808bc742187xxxxxx	下载任务的ID。
AsyncExecute	Boolean	true	是否是异步查询。 true：是异步查询。 false：不是异步查询，是同步查询。
CsvUrl	String	https://oss-xxxx-xxxx.xxxx......	OSS文件的下载地址。
CsvFileName	String	test_download_file	下载文件的名称。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDownloadDataJob
&IotInstanceId=iot-cn-npk1u******
&TableName=product_info
&DownloadDataType=TABLE
&StartTime=1658332800000
&EndTime=1658406464534
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDownloadDataJobResponse>
    <code>200</code>
    <data>
        <asyncExecute>true</asyncExecute>
        <longJobId>62d949808bc742187xxxxxx</longJobId>
        <resultDataInString/>
        <status>-1</status>
    </data>
    <requestId>C8E9E92F-ADD1-1434-BA90-E85F70F5C536</requestId>
    <success>true</success>
</CreateDownloadDataJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "asyncExecute" : true,
    "longJobId" : "62d949808bc742187xxxxxx",
    "resultDataInString" : "",
    "status" : -1
  },
  "requestId" : "C8E9E92F-ADD1-1434-BA90-E85F70F5C536",
  "success" : true
}