DescribeJobStatus - - Centre de documentation Alibaba Cloud

Consulte l'état d'une tâche.

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.

sae:DescribeJobStatus

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/job/describeJobStatus HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Oui	L'identifiant du modèle de tâche.	e1a7a07-abcb-4652-a1d3-2d57f415****
JobId	string	Non	L'identifiant de la tâche.	event-b798157b-40a2-4388-b578-71fb897103-

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
RequestId	string	L'identifiant de la requête.	53F15A18-8079-5992-810C-0211A5AE****
Message	string	Les informations supplémentaires. Valeurs valides : success : La requête a réussi. Code d'erreur spécifique : Une exception s'est produite et un code d'erreur spécifique est renvoyé.	success
TraceId	string	L'identifiant de trace utilisé pour interroger avec précision les informations d'appel.	0b1639af16575057857241351e****
Data	object	Les données renvoyées.
JobId	string	L'identifiant de la tâche.	event-b798157b-40a2-4388-b578-71fb897103-
Active	integer	Le nombre d'instances en cours d'exécution.	0
Succeeded	integer	Le nombre d'instances ayant réussi.	3
Failed	integer	Le nombre d'instances ayant échoué.	0
StartTime	integer	L'heure de création de la tâche.	1657522800
CompletionTime	integer	L'heure de fin de l'exécution de la tâche.	1657522839
Message	string	Les informations supplémentaires. Valeurs valides : success : La requête a réussi. Code d'erreur spécifique : Une exception s'est produite et un code d'erreur spécifique est renvoyé.	success
State	string	L'état d'exécution de la tâche. Valeurs valides : 0 : Non exécuté. 1 : Réussi. 2 : Échoué. 3 : En cours d'exécution.	1
ErrorCode	string	Le code d'erreur. Valeurs valides : Requête réussie : Le champ ErrorCode n'est pas renvoyé. Requête échouée : Le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidAppId.NotFound
Code	string	Le code d'état de l'API ou le code d'erreur POP. Valeurs valides : 2xx : Succès. 3xx : Redirection. 4xx : Erreur de requête. 5xx : Erreur de serveur.	200
Success	boolean	Indique si l'état de la tâche a été interrogé avec succès. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "JobId": "event-b798157b-40a2-4388-b578-71fb897103**-**",
    "Active": 0,
    "Succeeded": 3,
    "Failed": 0,
    "StartTime": 1657522800,
    "CompletionTime": 1657522839,
    "Message": "success",
    "State": "1"
  },
  "ErrorCode": "Null",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
404	InvalidAppId.NotFound	The specified AppId does not exist.	L'AppId spécifié n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.