GetDownloadFile - IoT Platform - Centre de documentation Alibaba Cloud

Remarques d'utilisation

Vous pouvez obtenir le lien de téléchargement d'une tâche jusqu'à trois fois par jour.
Un lien de téléchargement est valide pendant 5 minutes.

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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetDownloadFile	L'opération à effectuer. Définissez la valeur sur GetDownloadFile.
Context	Map	Non	{"xxx";xxx}	Le contenu de la requête.
IotInstanceId	String	Non	iot-cn-npk1u	L'ID de l'instance. Vous pouvez afficher l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, l'appel échouera. 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 la rubrique Vue d'ensemble.
LongJobId	String	Oui	62d949808bc742187xxxxxx	L'ID de la tâche renvoyé lors de la création de la tâche de téléchargement. Pour plus d'informations, consultez le paramètre CreateDownloadDataJob de l'opération CreateDownloadDataJob.

En plus des paramètres de requête spécifiques à l'opération répertorié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 la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	200	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
ErrorMessage	String	no authorization.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	BB71E443-4447-4024-A000-EDE09934****	L'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		Les données renvoyées.
Status	Integer	1	L'état de la tâche de téléchargement. Valeurs possibles : -1 : La tâche de téléchargement est en cours d'initialisation. 0 : La tâche de téléchargement est en cours d'exécution. 1 : La tâche de téléchargement a été exécutée. 2 : La tâche de téléchargement a échoué. 3 : La tâche de téléchargement est soumise et en attente d'exécution. 4 : La tâche de téléchargement est annulée.
LongJobId	String	62d949808bc742187xxxxxx	L'ID de la tâche de téléchargement.
BeginTime	Long	1658406464534	L'heure de début de la tâche de téléchargement.
AsyncExecute	Boolean	true	Indique si la requête est asynchrone. Valeurs possibles : true : La requête est asynchrone. false : La requête est synchrone.
TotalCount	Long	100	Le nombre total d'entrées renvoyées.
EndTime	Long	1658406465000	L'heure de fin de la tâche de téléchargement.
PreviewSize	Integer	100	Le nombre d'entrées par page d'aperçu.
PageNo	Integer	1	Le numéro de page.
PageSize	Integer	10	Le nombre d'entrées par page.
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	L'URL de téléchargement du fichier CSV stocké dans un compartiment Object Storage Service (OSS). L'URL est valide pendant 5 minutes.
CsvFileName	String	test_download_flie	Le nom du fichier CSV.
DatasetId	String	xxxxxx	L'ID de l'objet téléchargé.
ResultDataInString	String	{"a":123}	Le résultat de la requête.
Header	Array of Header		Les détails des champs renvoyés.
TypeClass	String	date	La dimension de type.
FieldName	String	user_name	Le nom du champ.
GeoClass	String	{xxx:xxxx}	Les informations géographiques.
FieldType	String	INTEGER	Le type du champ.
TimeClass	String	HOUR/DAY/MONTH	La dimension temporelle.
DimDateClass	String	DAY	Le type de planification.
Alias	String	user_name_alias	L'alias du champ.
Result	Array of Object	{"a":123}
QuerySetting	Object		Les détails de la requête.
SelectedHeaders	Array of SelectedHeaders		Les champs interrogés.
FieldName	String	user_name	Le nom du champ.
GeoClass	String	{xxx:xxx}	Les informations géographiques.
FieldType	String	INTEGER	Le type du champ.
TimeClass	String	HOUR/DAY/MONTH	La dimension de date.
Alias	String	user_name_alias	L'alias du champ.
DimDateClass	String	DAY	Le type de planification.
AstExpr	Array of AstExpr		Les conditions de requête.
ExprType	String	binaryOp	Le type d'expression.
Expr	String	{"header":{"fieldName":"xxx"},"operator":"GreaterThanOrEqual","value":12345}	Le contenu de l'expression.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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 format

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
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	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.downloadTaskNumUpperLimit	the number of downloaded tasks exceeded the upper limit	Le nombre de tâches de téléchargement exécutées au cours de la journée en cours 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 actuelle au cours de la journée en cours dépasse la limite.

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