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

使用说明

单个下载任务的下载链接一天内只能获取3次。
下载链接的有效期为5分钟。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	GetDownloadFile	系统规定参数。取值：GetDownloadFile。
Context	Map	否	{"xxx";xxx}	请求内容。
IotInstanceId	String	否	iot-cn-npk1u******	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无ID值，则无需传入。实例的更多信息，请参见实例概述。
LongJobId	String	是	62d949808bc742187xxxxxx	创建下载任务时返回的长任务ID，请参见CreateDownloadDataJob中的LongJobId参数。

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

返回数据

名称	类型	示例值	描述
Code	String	200	调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage	String	no authorization.	调用失败时，返回的错误信息。
RequestId	String	BB71E443-4447-4024-A000-EDE09934****	请求ID，阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。
Data	Object		数据。
Status	Integer	1	下载任务的执行状态。 -1：初始化中。 0：运行中。 1：执行成功。 2：执行失败。 3：已提交，等待中。 4：已取消。
LongJobId	String	62d949808bc742187xxxxxx	下载任务的ID。
BeginTime	Long	1658406464534	下载任务的开始时间。
AsyncExecute	Boolean	true	是否是异步查询。 true：是异步查询。 false：不是异步查询，是同步查询。
TotalCount	Long	100	总数。
EndTime	Long	1658406465000	下载任务的结束时间。
PreviewSize	Integer	100	预览大小。
PageNo	Integer	1	分页页码。
PageSize	Integer	10	分页大小。
CsvUrl	String	https://xxxxx-data-download-sh.oss-cn-shanghai.aliyuncs.com/data/download/6B761BxxxxxxxxAAA0BF03D32C80E/62da39b9xxxxxx5a7b953376/download_file_name.csv?Expires=1658469132&OSSAccessKeyId=xxxxxxxxx&Signature=rRL%xxxxxxx%3D	OSS文件的下载地址。（有效期5分钟）
CsvFileName	String	test_download_flie	CSV文件名称。
DatasetId	String	xxxxxx	下载对象ID。
ResultDataInString	String	{"a":123}	查询执行结果。
Header	Array of Header		字段信息。
TypeClass	String	date	类型。
FieldName	String	user_name	字段名。
GeoClass	String	{xxx:xxxx}	地理信息。
FieldType	String	INTEGER	字段数据类型。
TimeClass	String	HOUR/DAY/MONTH	时间维度。
DimDateClass	String	DAY	调度类型。
Alias	String	user_name_alias	字段别名。
Result	Array of Object	{"a":123}
QuerySetting	Object		查询请求信息。
SelectedHeaders	Array of SelectedHeaders		查询字段列表。
FieldName	String	user_name	字段名。
GeoClass	String	{xxx:xxx}	地理信息。
FieldType	String	INTEGER	字段数据类型。
TimeClass	String	HOUR/DAY/MONTH	日期维度。
Alias	String	user_name_alias	字段别名。
DimDateClass	String	DAY	调度类型。
AstExpr	Array of AstExpr		查询条件。
ExprType	String	binaryOp	表达式类型。
Expr	String	{"header":{"fieldName":"xxx"},"operator":"GreaterThanOrEqual","value":12345}	表达式内容。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDownloadFile
&IotInstanceId=iot-cn-npk1u******
&LongJobId=62d949808bc742187xxxxxx
&公共请求参数

正常返回示例

XML格式

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

<GetDownloadFileResponse>
    <code/>
    <data>
        <asyncExecute>true</asyncExecute>
        <csvFileName>download_file_name</csvFileName>
        <csvUrl>https://insight-data-download-sh.oss-cn-shanghai.aliyuncs.com/data/download/6B761B2617454C9C9AAA0BF03D32C80E/62da39b9a48f865a7b953376/download_file_name.csv?Expires=1658469132&amp;OSSAccessKeyId=xxxxxxxxx&amp;Signature=rRL%xxxxxxx%3D</csvUrl>
        <longJobId>62d949808bc742187xxxxxx</longJobId>
        <status>1</status>
    </data>
    <requestId>41CF72F4-63C1-1EBA-8590-89D0F0CD298A</requestId>
    <success>true</success>
</GetDownloadFileResponse>

JSON格式

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

{
  "code" : "",
  "data" : {
    "asyncExecute" : true,
    "csvFileName" : "download_file_name",
    "csvUrl" : "https://insight-data-download-sh.oss-cn-shanghai.aliyuncs.com/data/download/6B761B2617454C9C9AAA0BF03D32C80E/62da39b9a48f865a7b953376/download_file_name.csv?Expires=1658469132&amp;OSSAccessKeyId=xxxxxxxxx&amp;Signature=rRL%xxxxxxx%3D",
    "longJobId" : "62d949808bc742187xxxxxx",
    "status" : 1
  },
  "requestId" : "41CF72F4-63C1-1EBA-8590-89D0F0CD298A",
  "success" : true
}