ExecJob - - Centre de documentation Alibaba Cloud

Exécute 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:ExecJob

create

*All Resource

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/job/execJob 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.	ee1a7a07-abcb-4652-a1d3-2d57f415****
EventId	string	Non	L'identifiant de l'événement. Ce paramètre est défini par l'utilisateur et utilisé pour l'idempotence. Une seule tâche est créée pour le même identifiant d'événement.	custom
Command	string	Non	La commande de démarrage de l'image. La commande doit être un objet exécutable qui existe dans le conteneur. Exemple : `command: - echo - abc - > - file0` Sur la base de l'exemple précédent, Command="echo" et CommandArgs=["abc", ">", "file0"].	echo
CommandArgs	string	Non	Les arguments de la commande de démarrage de l'image. Il s'agit des arguments requis par la commande de démarrage Command. Format : `["a","b"]` Dans l'exemple précédent, CommandArgs=["abc", ">", "file0"]. La partie ["abc", ">", "file0"] doit être convertie en chaîne au format de tableau JSON. Si ce paramètre n'est pas requis, laissez-le vide.	["a","b"]
Envs	string	Non	Les variables d'environnement pour le conteneur. Vous pouvez personnaliser les variables d'environnement ou référencer des éléments de configuration. Pour référencer un élément de configuration, vous devez d'abord créer une instance ConfigMap. Pour plus d'informations, consultez CreateConfigMap. Valeurs valides : Configuration personnalisée name : le nom de la variable d'environnement. value : la valeur de la variable d'environnement. Éléments de configuration référencés name : le nom de la variable d'environnement. Vous pouvez référencer une clé unique ou toutes les clés. Pour référencer toutes les clés, saisissez sae-sys-configmap-all-<nom de l'élément de configuration>, par exemple, sae-sys-configmap-all-test1. valueFrom : la référence de la variable d'environnement. Définissez la valeur sur configMapRef. configMapId : l'identifiant de l'élément de configuration. key : la clé. Si vous référencez toutes les paires clé-valeur, ne définissez pas ce champ.	[{"name":"envtmp","value":"0"}]
JarStartOptions	string	Non	Les options de démarrage pour la tâche de package JAR. Commande de démarrage de tâche par défaut : `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`	-Xms4G -Xmx4G
JarStartArgs	string	Non	Les arguments de démarrage pour la tâche de package JAR. Commande de démarrage de tâche par défaut : `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	custom-args
WarStartOptions	string	Non	La commande de démarrage pour la tâche de déploiement de package WAR. La procédure de configuration est la même que celle pour la commande de démarrage de déploiement d'image. Pour plus d'informations, consultez Configurer une commande de démarrage.	CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run
Time	string	Non	L'heure à laquelle la tâche est déclenchée. Format : `yyyy-MM-dd'T'HH:mm:ss'Z'`.	2023-09-14T14:25:02Z
Replicas	string	Non	Le nombre d'instances simultanées pour la tâche.	3

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
Code	string	Le code d'état HTTP ou le code d'erreur POP. Valeurs valides : 2xx : Succès. 3xx : Redirection. 4xx : Erreur client. 5xx : Erreur serveur.	200
Data	object	Les données renvoyées.
Code	string	Le code d'état HTTP ou le code d'erreur POP. Valeurs valides : 2xx : Succès. 3xx : Redirection. 4xx : Erreur client. 5xx : Erreur serveur.	200
Data	string	L'identifiant de la tâche.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Msg	string	Les informations supplémentaires. Valeurs valides : Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur spécifique est renvoyé.	success
Success	string	Indique si la tâche a été exécutée avec succès. Valeurs valides : true : L'exécution a réussi. false : L'exécution a échoué.	true
ErrorCode	string	Le code d'erreur. Valeurs valides : Si la requête aboutit, le paramètre ErrorCode n'est pas renvoyé. Si la requête échoue, le paramètre ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidApplication.NotFound
Message	string	Les informations supplémentaires. Valeurs valides : Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur spécifique est renvoyé.	success
RequestId	string	L'identifiant de la requête.	67DD9A98-9CCC-5BE8-8C9E-B45E72F4****
Success	boolean	Indique si la tâche a été exécutée avec succès. Valeurs valides : true : L'exécution a réussi. false : L'exécution a échoué.	true
TraceId	string	L'identifiant de trace, qui est utilisé pour interroger avec précision les informations d'appel.	0b87b7e716575071334387401e****

Exemples

JSON format

{
  "Code": "200",
  "Data": {
    "Code": "200",
    "Data": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
    "Msg": "success",
    "Success": "true"
  },
  "ErrorCode": "InvalidApplication.NotFound",
  "Message": "success",
  "RequestId": "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Success": true,
  "TraceId": "0b87b7e716575071334387401e****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidApplication.NotFound	The current application does not exist.	L'application actuelle est introuvable.
400	JobForbidPolicy	You cannot execute new jobs because ongoing jobs exist.	Une tâche est en cours d'exécution. La nouvelle tâche ne peut pas être exécutée en raison de la stratégie de concurrence.
400	JobSuspend	The job is suspended.	La tâche a été arrêtée. Activez la tâche avant de l'exécuter.
400	user.indebt	The user has an outstanding payment.	L'utilisateur actuel présente un retard de paiement.

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

Notes de version

Consultez Notes de version pour la liste complète.