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

*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	Un identifiant d'événement personnalisable qui garantit l'idempotence. Le système ne crée qu'une seule tâche pour les requêtes ayant le même identifiant d'événement.	custom
Command	string	Non	La commande de démarrage, qui doit être un exécutable existant dans le conteneur. Exemple : `command: - echo - abc - > - file0` Sur la base de cet exemple, `Command` est `echo` et `CommandArgs` est `["abc", ">", "file0"]`.	echo
CommandArgs	string	Non	Les arguments du paramètre Command. La valeur doit être une chaîne représentant un tableau JSON. Format : `["a","b"]` Dans l'exemple précédent pour le paramètre `Command`, `CommandArgs` est `["abc", ">", "file0"]`. Le tableau JSON `["abc", ">", "file0"]` doit être converti en chaîne. Ce paramètre est facultatif.	["a","b"]
Envs	string	Non	Les variables d'environnement du conteneur. Vous pouvez spécifier des variables d'environnement personnalisées ou référencer une ConfigMap existante. Pour plus d'informations sur la création d'une ConfigMap, consultez CreateConfigMap. Configuration personnalisée name : le nom de la variable d'environnement. value : la valeur de la variable d'environnement. Référencer une ConfigMap name : le nom de la variable d'environnement. Vous pouvez référencer une seule clé ou toutes les clés. Pour référencer toutes les clés, utilisez le format `sae-sys-configmap-all-<nom de la ConfigMap>`. Exemple : `sae-sys-configmap-all-test1`. valueFrom : la source de la variable d'environnement. Définissez la valeur sur `configMapRef`. configMapId : l'identifiant de la ConfigMap. key : la clé que vous souhaitez référencer. Si vous souhaitez référencer toutes les paires clé-valeur, ne spécifiez pas ce paramètre.	[{"name":"envtmp","value":"0"}]
JarStartOptions	string	Non	Options de démarrage d'une tâche déployée à partir d'un package JAR. La commande de démarrage par défaut est : `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`	-Xms4G -Xmx4G
JarStartArgs	string	Non	Arguments de démarrage d'une tâche déployée à partir d'un package JAR. La commande de démarrage par défaut est : `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	custom-args
WarStartOptions	string	Non	La commande de démarrage pour une tâche déployée à partir d'un package WAR. La configuration est la même que pour un déploiement basé sur une 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 de déclenchement de la tâche, spécifiée au format `yyyy-MM-dd'T'HH:mm:ss'Z'`.	2023-09-14T14:25:02Z
Replicas	string	Non	Le nombre d'instances concurrentes.	3

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	67DD9A98-9CCC-5BE8-8C9E-B45E72F4****
Message	string	Le message renvoyé. Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur est renvoyé.	success
TraceId	string	L'identifiant de trace pour récupérer des informations détaillées sur l'appel.	0b87b7e716575071334387401e****
Data	object	Les données renvoyées.
Data	string	L'identifiant de la tâche.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Msg	string	Le message renvoyé. Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur est renvoyé.	success
Success	string	Indique si la tâche a été exécutée avec succès. true : l'exécution a réussi. false : l'exécution a échoué.	true
Code	string	Le code d'état HTTP ou un code d'erreur POP. 2xx : succès. 3xx : redirection. 4xx : erreur de requête. 5xx : erreur de serveur.	200
ErrorCode	string	Le code d'erreur. Ce paramètre est omis pour les requêtes réussies. Ce paramètre est inclus pour les requêtes ayant échoué. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Code	string	Le code d'état HTTP ou un code d'erreur POP. 2xx : succès. 3xx : redirection. 4xx : erreur de requête. 5xx : erreur de serveur.	200
Success	boolean	Indique si la requête a abouti. true : la requête a abouti. false : la requête a échoué.	true

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidApplication.NotFound	The current application does not exist.
400	JobForbidPolicy	You cannot execute new jobs because ongoing jobs exist.
400	JobSuspend	The job is suspended.
400	user.indebt	The user has an outstanding payment.

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

Notes de version

Consultez Notes de version pour la liste complète.