GetDownloadJob - - Centre de documentation Alibaba Cloud

Obtient les informations sur une tâche de téléchargement de journaux.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

log:GetDownloadJob

get

*Project

acs:log:{#regionId}:{#accountId}:project/{#project}/downloadjob/{#downloadJobName}

Aucune

Syntaxe de la requête

GET /downloadjobs/{downloadJobName} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
downloadJobName	string	Oui	Le nom de la tâche de téléchargement de journaux.	download-123

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
project	string	Oui	Le nom du projet.	ali-test-project

Éléments de réponse

Élément	Type	Description	Exemple
	object	Informations sur la tâche de téléchargement.
status	string	L'état de la tâche de téléchargement.	STARTING、RUNNING、SUCCEEDED、ERROR
name	string	Le nom de la tâche de téléchargement.	download-123
description	string	La description.	une tâche de téléchargement
configuration	object	La configuration du téléchargement.
logstore	string	Le Logstore source.	ali-test-logstore
fromTime	integer	L'horodatage de début, en secondes.	1722409860
toTime	integer	L'horodatage de fin, en secondes.	1722411060
query	string	L'instruction de requête.	* \| select *
powerSql	boolean	Indique si PowerSQL est activé.	false
allowInComplete	boolean	Indique si le téléchargement de données incomplètes est autorisé. Valeurs valides : true : true. false : false.	true
sink	object	La configuration de l'exportation.
type	string	Valeur fixe : AliyunOSS.	AliyunOSS
contentType	string	Le format du fichier téléchargé.	csv
compressionType	string	Le format de compression.	none
roleArn	string	L'ARN du rôle RAM utilisé pour le téléchargement.	acs:ram::0123456789:role/aliyunlogdefaultrole
bucket	string	Le bucket OSS.	ali-test-oss-bucket
prefix	string	Le préfixe de fichier utilisé lors du téléchargement des journaux dans le bucket OSS de l'utilisateur.	download/
createTime	string	L'heure de création.	1722411060
displayName	string	Le nom d'affichage.	download-123456
executionDetails	object	Les détails de l'exécution.
progress	integer	La progression du téléchargement.	100
filePath	string	Le lien du résultat du téléchargement.	https://xxx.csv.zst?xxx
fileSize	integer	La taille du fichier téléchargé.	123456
executeTime	integer	Le temps d'exécution du téléchargement.	123
logCount	integer	Le nombre d'entrées de journal téléchargées.	123
errorMessage	string	Le message d'erreur du téléchargement.	timeout
checkSum	string	L'ETag du fichier.	EXSFGSDASDASDG123ASD
notice	string	Le texte de la notification.	test

Exemples

JSON format

{
  "status": "STARTING, RUNNING, SUCCEEDED, ERROR",
  "name": "download-123",
  "description": "une tâche de téléchargement",
  "configuration": {
    "logstore": "ali-test-logstore",
    "fromTime": 1722409860,
    "toTime": 1722411060,
    "query": "* | select *",
    "powerSql": false,
    "allowInComplete": true,
    "sink": {
      "type": "AliyunOSS",
      "contentType": "csv",
      "compressionType": "none",
      "roleArn": "acs:ram::0123456789:role/aliyunlogdefaultrole",
      "bucket": "ali-test-oss-bucket",
      "prefix": "download/"
    }
  },
  "createTime": "1722411060",
  "displayName": "download-123456",
  "executionDetails": {
    "progress": 100,
    "filePath": "https://xxx.csv.zst?xxx",
    "fileSize": 123456,
    "executeTime": 123,
    "logCount": 123,
    "errorMessage": "délai d'attente dépassé",
    "checkSum": "EXSFGSDASDASDG123ASD",
    "notice": "test"
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.