GetDownloadFile - IoT Platform - Centro de documentación de Alibaba Cloud

Obtiene el resultado de una tarea de descarga de tabla de datos.

Notas de uso

El enlace de descarga de una tarea se puede obtener hasta tres veces al día.
Un enlace de descarga tiene una validez de 5 minutos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetDownloadFile	La operación que desea ejecutar. Establezca el valor en GetDownloadFile.
Context	Map	No	{"xxx";xxx}	El contenido de la solicitud.
IotInstanceId	String	No	iot-cn-npk1u	El ID de la instancia. Consulte el ID en la página descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la llamada fallará. Si la página descripción general o el ID de la instancia no se muestran en la consola de IoT Platform, omita este parámetro. Para obtener más información sobre las instancias, consulte Descripción general.
LongJobId	String	Sí	62d949808bc742187xxxxxx	El ID de la tarea devuelto al crear la tarea de descarga. Para obtener más información, consulte el parámetro CreateDownloadDataJob de la operación CreateDownloadDataJob.

Además de los parámetros de solicitud específicos de la operación listados anteriormente, debe especificar los parámetros de solicitud comunes cuando llame a esta operación. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	200	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	no authorization.	El mensaje de error devuelto si la llamada falla.
RequestId	String	BB71E443-4447-4024-A000-EDE09934****	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.
Data	Object		Los datos devueltos.
Status	Integer	1	El estado de la tarea de descarga. Valores válidos: -1: La tarea de descarga se está inicializando. 0: La tarea de descarga se está ejecutando. 1: La tarea de descarga se ejecutó. 2: La tarea de descarga finalizó con errores. 3: La tarea de descarga se envió y está pendiente de ejecución. 4: La tarea de descarga se canceló.
LongJobId	String	62d949808bc742187xxxxxx	El ID de la tarea de descarga.
BeginTime	Long	1658406464534	La hora de inicio de la tarea de descarga.
AsyncExecute	Boolean	true	Indica si la consulta es asíncrona. Valores válidos: true: La consulta es asíncrona. false: La consulta es síncrona.
TotalCount	Long	100	El número total de entradas devueltas.
EndTime	Long	1658406465000	La hora de finalización de la tarea de descarga.
PreviewSize	Integer	100	El número de entradas por página de vista previa.
PageNo	Integer	1	El número de página.
PageSize	Integer	10	El número de entradas por página.
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	La URL de descarga del archivo CSV almacenado en un bucket de Object Storage Service (OSS). La URL tiene una validez de 5 minutos.
CsvFileName	String	test_download_flie	El nombre del archivo CSV.
DatasetId	String	xxxxxx	El ID del objeto descargado.
ResultDataInString	String	{"a":123}	El resultado de la consulta.
Header	Array of Header		Los detalles de los campos devueltos.
TypeClass	String	date	La dimensión de tipo.
FieldName	String	user_name	El nombre del campo.
GeoClass	String	{xxx:xxxx}	La información geográfica.
FieldType	String	INTEGER	El tipo del campo.
TimeClass	String	HOUR/DAY/MONTH	La dimensión de tiempo.
DimDateClass	String	DAY	El tipo de programación.
Alias	String	user_name_alias	El alias del campo.
Result	Array of Object	{"a":123}
QuerySetting	Object		Los detalles de la consulta.
SelectedHeaders	Array of SelectedHeaders		Los campos consultados.
FieldName	String	user_name	El nombre del campo.
GeoClass	String	{xxx:xxx}	La información geográfica.
FieldType	String	INTEGER	El tipo del campo.
TimeClass	String	HOUR/DAY/MONTH	La dimensión de fecha.
Alias	String	user_name_alias	El alias del campo.
DimDateClass	String	DAY	El tipo de programación.
AstExpr	Array of AstExpr		Las condiciones de la consulta.
ExprType	String	binaryOp	El tipo de la expresión.
Expr	String	{"header":{"fieldName":"xxx"},"operator":"GreaterThanOrEqual","value":12345}	El contenido de la expresión.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDownloadFile
&IotInstanceId=iot-cn-npk1u******
&LongJobId=62d949808bc742187xxxxxx
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato 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>

Formato 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
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.dap.insight.noAuthorization	no authorization.	No tiene permisos para ejecutar la operación.
400	iot.dap.insight.requestParamError	request param error.	El parámetro de solicitud especificado no es válido.
400	iot.dap.insight.serverError	server hsf error please try later	Ocurrió un error en el servicio backend High-speed Service Framework (HSF). Inténtelo de nuevo más tarde.
400	iot.dap.insight.downloadTaskNumUpperLimit	the number of downloaded tasks exceeded the upper limit	El número de tareas de descarga ejecutadas hoy supera el límite.
400	iot.dap.insight.downloadTimesUpperLimit	the number of current job downloaded tasks exceeded the upper limit	El número de descargas de la tarea actual hoy supera el límite.

Para consultar la lista de códigos de error, visite Códigos de error del servicio.