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

Cree una tarea de descarga de datos.

Notas de uso

Después de llamar a esta operación, la tarea de descarga se muestra en la consola de IoT Platform. En la pestaña Exporting de la tabla correspondiente, consulte los registros de la tarea y descargue el archivo.
Al llamar a esta operación, se genera un mensaje que se puede enviar mediante Advanced Message Queuing Protocol (AMQP). Establezca el parámetro consumerGroupId como dop_aliyun_group_name. El mensaje contiene el estado de la tarea de descarga. Según este estado, llame a la operación GetDownloadFile para obtener la URL de descarga del archivo o consultar los detalles del error.

Límites

Solo se permite ejecutar una tarea de descarga por instancia de datos al mismo tiempo. Cree una nueva tarea únicamente cuando finalice la anterior. De lo contrario, se devuelve un error que indica que se superó el límite de tareas de descarga.
Únicamente es posible descargar los datos de los tres días anteriores.
Se pueden crear hasta tres tareas de descarga por día. Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera de forma dinámica el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateDownloadDataJob	La operación que desea ejecutar. Establezca el valor como CreateDownloadDataJob.
IotInstanceId	String	No	iot-cn-npk1u	El ID de la instancia. Consulte el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada falla. Si la página Overview 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.
TableName	String	Sí	product_info	El nombre de la tabla que desea descargar.
DownloadDataType	String	Sí	TABLE	El tipo de objeto que desea descargar. Establezca el valor como TABLE.
FileConfig	Map	No	{"fileName":"fileName01"}	La configuración del archivo. Use el campo fileName para especificar un nombre de archivo personalizado. Si no establece este campo, se genera un nombre de archivo automáticamente.
StartTime	Long	No	1658332800000	El inicio del intervalo de tiempo que se va a consultar.
EndTime	Long	No	1658406464534	El fin del intervalo de tiempo que se va a consultar.

Además de los parámetros de solicitud específicos de la operación que se listan arriba, especifique los parámetros de solicitud comunes al llamar 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 que se devuelve si la llamada falla. Para obtener más información sobre los códigos de error, consulte Códigos de error.
ErrorMessage	String	no authorization.	El mensaje de error que se devuelve si la llamada falla.
RequestId	String	4D6D7F71-1C94-4160-8511-EFF4B8F0643F	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		El resultado devuelto.
Status	Integer	-1	El estado de la tarea. Valores válidos: -1: la tarea se está inicializando. 0: la tarea se está ejecutando. 1: la tarea se ejecutó. 2: la ejecución de la tarea falló. 3: la tarea se envió y está pendiente de ejecución. 4: la tarea se canceló.
LongJobId	String	62d949808bc742187xxxxxx	El ID de la tarea de descarga.
AsyncExecute	Boolean	true	Indica si la tarea se ejecuta de forma asíncrona. Valores válidos: true: la tarea se ejecuta de forma asíncrona. false: la tarea se ejecuta de forma síncrona.
CsvUrl	String	https://oss-xxxx-xxxx.xxxx......	La URL de descarga del archivo CSV almacenado en Object Storage Service (OSS).
CsvFileName	String	test_download_file	El nombre del archivo descargado.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDownloadDataJob
&IotInstanceId=iot-cn-npk1u******
&TableName=product_info
&DownloadDataType=TABLE
&StartTime=1658332800000
&EndTime=1658406464534
&<Common request parameters>

Respuestas exitosas de ejemplo

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

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

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.queryTimeMoreThanQueryDays	The query time range exceeded the allowed time range	El intervalo de tiempo de consulta no es válido.
400	iot.dap.insight.processDownloadJobMoreConcurrenceCount	the number of concurrent download tasks in progress exceeds the upper limit	La cantidad de tareas de descarga que se ejecutan simultáneamente supera el límite.
400	iot.dap.insight.downloadTimesUpperLimit	the number of current job downloaded tasks exceeded the upper limit	La cantidad de descargas de la tarea de descarga del día actual supera el límite.
400	iot.dap.insight.downloadTaskNumUpperLimit	the number of downloaded tasks exceeded the upper limit	La cantidad de tareas de descarga ejecutadas durante el día actual supera el límite.

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