StartExecution - - Centre de documentation Alibaba Cloud

Démarre une exécution de 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.

oos:StartExecution

update

*Execution.

acs:oos:{#regionId}:{#accountId}:execution/*

oos:tag
oos:IsOOSAssumeRole
oos:TLSVersion

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou
TemplateName	string	Non	Le nom du modèle. Le nom peut contenir des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_), et peut comporter jusqu'à 200 caractères.	vmeixme
TemplateVersion	string	Non	Le numéro de version. Si vous ne spécifiez pas ce paramètre, le numéro de version le plus récent est utilisé par défaut.	v1
Mode	string	Non	Le mode d'exécution. Valeurs valides : Automatic (par défaut) : exécution automatique FailurePause : mise en pause en cas d'échec Debug : exécution étape par étape	Automatic
LoopMode	string	Non	Le mode de boucle. Valeurs valides : Automatic (par défaut) : aucune pause FirstBatchPause : mise en pause après le premier lot EveryBatchPause : mise en pause après chaque lot	Automatic
ParentExecutionId `deprecated`	string	Non	L'identifiant de l'exécution parente.	exec-xxx
SafetyCheck	string	Non	Le mode de vérification de sécurité. Valeurs valides : Skip (par défaut) : cette option indique que le client est conscient des risques et que toute action peut être exécutée sans confirmation, quel que soit le niveau de risque. Cette option n'est valide que lorsque Mode=Automatic. ConfirmEveryHighRiskAction : cette option exige que le client confirme chaque action à haut risque. Le client peut confirmer ou annuler en appelant l'opération NotifyExecution.	Skip
Parameters	string	Non	Une chaîne JSON composée d'un ensemble de paramètres. Valeur par défaut : {}.	{"Status":"Running"}
ClientToken	string	Non	Le jeton d'accès.	123e56767-e89b-12d3-a456-426655440000
Tags	object	Non	Les balises à ajouter à l'exécution de la tâche.	{ "k1": "v1", "k2": "v2" }
Description	string	Non	La description à ajouter à l'exécution de la tâche.	exécution de test
TemplateContent	string	Non	Le contenu du modèle au format JSON ou YAML. Il s'agit du même champ que Content dans les paramètres de requête CreateTemplate. Si vous spécifiez ce paramètre, les tâches dans TemplateContent sont directement exécutées sans qu'il soit nécessaire de créer d'abord un modèle. Vous n'avez pas besoin de spécifier ce paramètre si vous utilisez un modèle existant pour créer une exécution de tâche.	{ "Description": "Modèle d'exemple, décrit les instances dans un certain état", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [ { "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } } ] }
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmxsn4m4******
TemplateURL	string	Non	L'URL du contenu du modèle OOS stocké dans Alibaba Cloud Object Storage Service (OSS). Seules les URL lisibles publiquement sont prises en charge. Si vous spécifiez ce paramètre, une exécution de tâche est créée en fonction du contenu du modèle stocké à l'adresse TemplateURL sans qu'il soit nécessaire de créer d'abord un modèle. Vous n'avez pas besoin de spécifier ce paramètre si vous utilisez un modèle existant pour créer une exécution de tâche.	http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	14A07460-EBE7-47CA-9757-12CC4761D47A
Execution	object	Les données d'exécution de la tâche.
Outputs	string	La sortie de l'exécution de la tâche.	{ "InstanceId":"i-xxx" }
Status	string	L'état de l'exécution de la tâche.	Success
EndDate	string	L'heure de fin au format ISO 8601 (UTC).	2019-05-16T10:26:14Z
ExecutedBy	string	L'utilisateur qui a exécuté le modèle.	root(13092080xx12344)
IsParent	boolean	Indique si l'exécution de la tâche contient des tâches enfants.	false
Tags	object	Les balises de l'exécution de la tâche.	{"k1":"v2","k2":"v2"}
StartDate	string	L'heure de début au format ISO 8601 (UTC).	2019-05-16T10:26:14Z
SafetyCheck	string	Le mode de vérification de sécurité.	Skip
Mode	string	Le mode d'exécution.	Automatic
TemplateName	string	Le nom du modèle.	MyTemplate
CreateDate	string	L'heure de création de l'exécution de la tâche, au format ISO 8601 (UTC).	2019-05-16T10:26:14Z
TemplateVersion	string	Le numéro de version du modèle.	v1
ExecutionId	string	L'identifiant unique de l'exécution de la tâche.	exec-xxxyyy
Parameters	string	Les paramètres d'entrée de l'exécution de la tâche.	{ "Status":"Running" }
Description	string	La description de l'exécution de la tâche.	exécution de test
Counters	object	Le nombre d'exécutions.	1
UpdateDate	string	L'heure de mise à jour au format ISO 8601 (UTC).	2019-05-16T10:26:14Z
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxsn4m4******
ParentExecutionId	string	L'identifiant de l'exécution parente.	exec-xxxx
RamRole	string	Le rôle RAM utilisé pour exécuter le modèle.	OOSServiceRole
TemplateId	string	L'identifiant du modèle.	t-1bd341007f
StatusMessage	string	Le message d'état.	""
LoopMode	string	Le mode de boucle.	Automatic
CurrentTasks	array<object>	Les tâches en cours d'exécution.
	object
TaskExecutionId	string	L'identifiant de l'exécution de la tâche.	exec-dsadasdawq
TaskName	string	Le nom de la tâche.	testTask
TaskAction	string	L'action de la tâche.	ACS::TimerTrigger

Exemples

JSON format

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "Execution": {
    "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
    "Status": "Success",
    "EndDate": "2019-05-16T10:26:14Z",
    "ExecutedBy": "root(13092080xx12344)",
    "IsParent": false,
    "Tags": {
      "k1": "v2",
      "k2": "v2"
    },
    "StartDate": "2019-05-16T10:26:14Z",
    "SafetyCheck": "Skip",
    "Mode": "Automatic",
    "TemplateName": "MyTemplate",
    "CreateDate": "2019-05-16T10:26:14Z",
    "TemplateVersion": "v1",
    "ExecutionId": "exec-xxxyyy",
    "Parameters": "{ \"Status\":\"Running\" }",
    "Description": "exécution de test",
    "Counters": 1,
    "UpdateDate": "2019-05-16T10:26:14Z",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "ParentExecutionId": "exec-xxxx",
    "RamRole": "OOSServiceRole",
    "TemplateId": "t-1bd341007f",
    "StatusMessage": "\"\"",
    "LoopMode": "Automatic",
    "CurrentTasks": [
      {
        "TaskExecutionId": "exec-dsadasdawq",
        "TaskName": "testTask",
        "TaskAction": "ACS::TimerTrigger"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.