CreateDownloadDataJob - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Après avoir appelé cette opération, la tâche de téléchargement s'affiche dans la console IoT Platform. Dans l'onglet Exporting du tableau correspondant, consultez les journaux de la tâche et téléchargez le fichier.
Lors de l'appel à cette opération, un message est généré et peut être envoyé via le protocole Advanced Message Queuing Protocol (AMQP). Définissez le paramètre consumerGroupId sur dop_aliyun_group_name. Ce message contient le statut de la tâche de téléchargement. Selon le statut, appelez l'opération GetDownloadFile pour obtenir l'URL de téléchargement du fichier ou afficher les détails de l'erreur.

Limites

Une seule tâche de téléchargement peut s'exécuter à la fois par instance de données. Créez une nouvelle tâche uniquement après la fin de la précédente. Sinon, une erreur indiquant que le nombre de tâches de téléchargement dépasse la limite est renvoyée.
Vous ne pouvez télécharger que les données des trois derniers jours.
Vous pouvez créer au maximum trois tâches de téléchargement par jour. Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateDownloadDataJob	Opération à effectuer. Définissez la valeur sur CreateDownloadDataJob.
IotInstanceId	String	No	iot-cn-npk1u	ID de l'instance. Obtenez l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. Sinon, l'appel échoue. Si la page Overview ou l'ID de l'instance n'est pas affiché dans la console IoT Platform, ignorez ce paramètre. Pour plus d'informations sur les instances, consultez Overview.
TableName	String	Yes	product_info	Nom de la table à télécharger.
DownloadDataType	String	Yes	TABLE	Type de l'objet à télécharger. Définissez la valeur sur TABLE.
FileConfig	Map	No	{"fileName":"fileName01"}	Paramètres du fichier. Utilisez le champ fileName pour spécifier un nom de fichier personnalisé. Si vous ne définissez pas ce champ, un nom de fichier est généré automatiquement.
StartTime	Long	No	1658332800000	Début de la plage horaire à interroger.
EndTime	Long	No	1658406464534	Fin de la plage horaire à interroger.

Outre les paramètres de requête spécifiques à l'opération listés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez Common parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	200	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations sur les codes d'erreur, consultez Error codes.
ErrorMessage	String	no authorization.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	4D6D7F71-1C94-4160-8511-EFF4B8F0643F	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.
Data	Object		Résultat renvoyé.
Status	Integer	-1	Statut de la tâche. Valeurs possibles : -1 : La tâche est en cours d'initialisation. 0 : La tâche est en cours d'exécution. 1 : La tâche a été exécutée. 2 : L'exécution de la tâche a échoué. 3 : La tâche a été soumise et est en attente d'exécution. 4 : La tâche a été annulée.
LongJobId	String	62d949808bc742187xxxxxx	ID de la tâche de téléchargement.
AsyncExecute	Boolean	true	Indique si la tâche s'exécute de manière asynchrone. Valeurs possibles : true : La tâche s'exécute de manière asynchrone. false : La tâche s'exécute de manière synchrone.
CsvUrl	String	https://oss-xxxx-xxxx.xxxx......	URL de téléchargement du fichier CSV stocké dans Object Storage Service (OSS).
CsvFileName	String	test_download_file	Nom du fichier téléchargé.

Exemples

Exemple de requête

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>

Exemple de réponse réussie

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

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

Codes d'erreur

HttpCode	Error code	Error message	Description
400	iot.dap.insight.noAuthorization	no authorization.	Vous ne disposez pas des autorisations nécessaires pour effectuer l'opération.
400	iot.dap.insight.requestParamError	request param error.	Le paramètre de requête spécifié n'est pas valide.
400	iot.dap.insight.serverError	server hsf error please try later	Une erreur s'est produite dans le service backend High-speed Service Framework (HSF). Réessayez ultérieurement.
400	iot.dap.insight.queryTimeMoreThanQueryDays	The query time range exceeded the allowed time range	La plage horaire à interroger n'est pas valide.
400	iot.dap.insight.processDownloadJobMoreConcurrenceCount	the number of concurrent download tasks in progress exceeds the upper limit	Le nombre de tâches de téléchargement exécutées simultanément dépasse la limite.
400	iot.dap.insight.downloadTimesUpperLimit	the number of current job downloaded tasks exceeded the upper limit	Le nombre de téléchargements pour la tâche de téléchargement en cours durant la journée actuelle dépasse la limite.
400	iot.dap.insight.downloadTaskNumUpperLimit	the number of downloaded tasks exceeded the upper limit	Le nombre de tâches de téléchargement exécutées durant la journée actuelle dépasse la limite.

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.