GetDownloadFile
調(diào)用該接口獲取數(shù)據(jù)表數(shù)據(jù)下載任務(wù)的執(zhí)行結(jié)果。
使用說明
- 單個(gè)下載任務(wù)的下載鏈接一天內(nèi)只能獲取3次。
- 下載鏈接的有效期為5分鐘。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | GetDownloadFile | 系統(tǒng)規(guī)定參數(shù)。取值:GetDownloadFile。 |
Context | Map | 否 | {"xxx";xxx} | 請(qǐng)求內(nèi)容。 |
IotInstanceId | String | 否 | iot-cn-npk1u****** | 實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁面,查看當(dāng)前實(shí)例的ID。 重要
實(shí)例的更多信息,請(qǐng)參見實(shí)例概述。 |
LongJobId | String | 是 | 62d949808bc742187xxxxxx | 創(chuàng)建下載任務(wù)時(shí)返回的長(zhǎng)任務(wù)ID,請(qǐng)參見CreateDownloadDataJob中的LongJobId參數(shù)。 |
調(diào)用API時(shí),除了本文介紹的該API的特有請(qǐng)求參數(shù),還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明,請(qǐng)參見公共參數(shù)文檔。
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 調(diào)用失敗時(shí),返回的錯(cuò)誤碼。更多信息,請(qǐng)參見錯(cuò)誤碼。 |
ErrorMessage | String | no authorization. | 調(diào)用失敗時(shí),返回的錯(cuò)誤信息。 |
RequestId | String | BB71E443-4447-4024-A000-EDE09934**** | 請(qǐng)求ID,阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
Data | Object | 數(shù)據(jù)。 |
|
Status | Integer | 1 | 下載任務(wù)的執(zhí)行狀態(tài)。
|
LongJobId | String | 62d949808bc742187xxxxxx | 下載任務(wù)的ID。 |
BeginTime | Long | 1658406464534 | 下載任務(wù)的開始時(shí)間。 |
AsyncExecute | Boolean | true | 是否是異步查詢。
|
TotalCount | Long | 100 | 總數(shù)。 |
EndTime | Long | 1658406465000 | 下載任務(wù)的結(jié)束時(shí)間。 |
PreviewSize | Integer | 100 | 預(yù)覽大小。 |
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 | 下載對(duì)象ID。 |
ResultDataInString | String | {"a":123} | 查詢執(zhí)行結(jié)果。 |
Header | Array of Header | 字段信息。 |
|
TypeClass | String | date | 類型。 |
FieldName | String | user_name | 字段名。 |
GeoClass | String | {xxx:xxxx} | 地理信息。 |
FieldType | String | INTEGER | 字段數(shù)據(jù)類型。 |
TimeClass | String | HOUR/DAY/MONTH | 時(shí)間維度。 |
DimDateClass | String | DAY | 調(diào)度類型。 |
Alias | String | user_name_alias | 字段別名。 |
Result | Array of Object | {"a":123} | |
QuerySetting | Object | 查詢請(qǐng)求信息。 |
|
SelectedHeaders | Array of SelectedHeaders | 查詢字段列表。 |
|
FieldName | String | user_name | 字段名。 |
GeoClass | String | {xxx:xxx} | 地理信息。 |
FieldType | String | INTEGER | 字段數(shù)據(jù)類型。 |
TimeClass | String | HOUR/DAY/MONTH | 日期維度。 |
Alias | String | user_name_alias | 字段別名。 |
DimDateClass | String | DAY | 調(diào)度類型。 |
AstExpr | Array of AstExpr | 查詢條件。 |
|
ExprType | String | binaryOp | 表達(dá)式類型。 |
Expr | String | {"header":{"fieldName":"xxx"},"operator":"GreaterThanOrEqual","value":12345} | 表達(dá)式內(nèi)容。 |
示例
請(qǐng)求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDownloadFile
&IotInstanceId=iot-cn-npk1u******
&LongJobId=62d949808bc742187xxxxxx
&公共請(qǐng)求參數(shù)
正常返回示例
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&OSSAccessKeyId=xxxxxxxxx&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&OSSAccessKeyId=xxxxxxxxx&Signature=rRL%xxxxxxx%3D",
"longJobId" : "62d949808bc742187xxxxxx",
"status" : 1
},
"requestId" : "41CF72F4-63C1-1EBA-8590-89D0F0CD298A",
"success" : true
}