InvokeCommand - Elastic Compute Service - Centre de documentation Alibaba Cloud

Déclenche une commande Cloud Assistant sur une ou plusieurs instances ECS en spécifiant des paramètres tels que CommandId, InstanceId et ResourceGroupId.

Description de l'opération

Description de l'opération.

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.

ecs:InvokeCommand

update

*Command.

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

*Instance.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

ecs:CommandRunAs

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources pour l'exécution de la commande. Lorsque ce paramètre est spécifié :	rg-bp67acfmxazb4p****
CommandId	string	Oui	L'identifiant de la commande. Vous pouvez appeler DescribeCommands pour obtenir tous les identifiants de commande disponibles.	c-e996287206324975b5fbe1d****
RepeatMode	string	Non	Le mode d'exécution de la commande. Valeurs valides :	Once
Timed	boolean	Non	[Obsolète] Ce paramètre est obsolète. La spécification de ce paramètre n'a aucun effet.	true
Frequency	string	Non	La planification selon laquelle la commande est exécutée. Trois types d'exécution planifiée sont pris en charge : l'exécution à intervalles fixes (basée sur une expression Rate), l'exécution unique à une heure spécifiée, et l'exécution planifiée basée sur l'horloge (basée sur une expression Cron).	0 /20 * * ?
Parameters	object	Non	Les paires clé-valeur des paramètres personnalisés à transmettre lors de l'exécution de la commande avec la fonctionnalité de paramètres personnalisés activée. Le nombre de paramètres personnalisés varie de 0 à 10.	{"name":"Jack", "accessKey":"LTAI************"}
Username	string	Non	Le nom d'utilisateur utilisé pour exécuter la commande sur l'instance ECS. La longueur ne peut pas dépasser 255 caractères.	test
WindowsPasswordName	string	Non	Le mot de passe de l'utilisateur qui exécute la commande sur une instance Windows. La longueur ne peut pas dépasser 255 caractères.	axtSecretPassword
InstanceId	array	Non	La liste des instances sur lesquelles exécuter la commande. Vous pouvez spécifier jusqu'à 100 identifiants d'instance. Valeurs valides de N : 1 à 100.	i-bp185dy2o3o6n****
	string	Non	L'identifiant de l'instance sur laquelle exécuter la commande.	i-bp185dy2o3o6n****
ContainerId	string	Non	L'identifiant du conteneur. Seules les chaînes hexadécimales de 64 bits sont prises en charge. Vous pouvez utiliser le préfixe docker://, containerd:// ou cri-o:// pour spécifier l'environnement d'exécution du conteneur.	ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerName	string	Non	Le nom du conteneur.	test-container
Timeout	integer	Non	Le délai d'expiration pour l'exécution de la commande. Unité : secondes.	60
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
Value	string	Non	La valeur de balise de l'exécution de la commande. Valeurs valides de N : 1 à 20. La valeur peut être une chaîne vide.	TestValue
Key	string	Non	La clé de balise de l'exécution de la commande. Valeurs valides de N : 1 à 20. La clé de balise ne peut pas être une chaîne vide une fois spécifiée.	TestKey
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais assurez-vous que le jeton est unique parmi les différentes requêtes. La valeur de ClientToken ne peut contenir que des caractères ASCII et ne peut pas dépasser 64 caractères. Pour plus d'informations, consultez Comment garantir l'idempotence.	123e4567-e89b-12d3-a456-42665544****
ResourceTag	array<object>	Non	Les balises utilisées pour filtrer les instances. Vous pouvez exécuter des commandes par lots sur des instances ayant la même balise sans spécifier InstanceId.
	object	Non	La balise utilisée pour filtrer les instances. Vous pouvez exécuter des commandes par lots sur des instances ayant la même balise sans spécifier InstanceId.
Value	string	Non	La valeur de balise utilisée pour filtrer les instances.	TestValue
Key	string	Non	La clé de balise utilisée pour filtrer les instances.	TestKey
TerminationMode	string	Non	Le mode d'arrêt de la tâche (arrêt manuel ou interruption par délai d'expiration). Valeurs valides :	ProcessTree
Launcher	string	Non	Le programme d'amorçage pour l'exécution du script. La longueur ne peut pas dépasser 1 Ko.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
WorkingDir	string	Non	Le répertoire dans lequel la commande est exécutée sur l'instance ECS. La longueur ne peut pas dépasser 200 caractères.	/home/user
OssOutputDelivery	string	Non	La configuration de livraison OSS pour la sortie d'exécution de la commande.	oss://testBucket/testPrefix

Éléments de réponse

Élément	Type	Description	Exemple
	object
InvokeId	string	L'identifiant d'exécution de la commande.	t-7d2a745b412b4601b2d47f6a768d****
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Exemples

JSON format

{
  "InvokeId": "t-7d2a745b412b4601b2d47f6a768d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ResourceBusy.SlrCreation	The ServiceLinkedRole is still being created or has not taken effect yet. Please try again later.
400	RegionId.ApiNotSupported	The api is not supported in this region.	Cette API n'est pas prise en charge dans la région actuelle.
400	InvalidParameter.WorkingDir	The specified parameter WorkingDir is not valid.	Le paramètre WorkingDir spécifié n'est pas valide.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	L'identifiant de l'instance est vide.
400	InvalidContainerId.Malformed	The specified parameter ContainerId is not valid.	L'identifiant de conteneur spécifié n'est pas valide.
400	InvalidContainerName.Malformed	The specified parameter ContainerName is not valid.	Le nom de conteneur spécifié n'est pas valide.
400	InvalidClientToken.Malformed	The specified parameter clientToken is not valid.	Le paramètre ClientToken spécifié ne respecte pas les exigences de format. Le paramètre doit contenir uniquement des caractères ASCII et ne peut pas dépasser 64 caractères.
400	InvalidInstance.NotMatch	The specified instance type does not match the command.
400	MissingParam.Frequency	The frequency must be specified when you create a timed task.
400	InvalidParam.Frequency	The specified frequency is invalid.
400	Parameter.MissingValue	The parameter value of this command is required.
400	Parameter.Disabled	Parameters cannot be passed in when the command customization function is disabled.
400	InvalidParameter.Parameters	The specified parameter Parameters is not valid.	Le paramètre Parameters spécifié est invalide.
400	NumberExceed.ResourceTags	The maximum number of ResourceTags is exceeded.
400	MissingParameter.ResourceTagKey	You must specify ResourceTag.N.Key.
400	InvalidResourceTagKey.Malformed	The specified ResourceTag key is not valid.
400	InvalidResourceTagValue.Malformed	The specified ResourceTag value is not valid.
400	Duplicate.ResourceTagKey	The ResourceTag contains duplicate keys.
400	InvalidResourceTag.InstanceNotFound	InstanceIds are not found by the specified ResourceTag.
400	InvalidResourceTag.ConflictWithInstanceIds	The specified param ResourceTag conflicts with InstanceId.
400	InvalidOssOutputDelivery.BucketInOtherRegion	The OSS bucket specified in the parameter OssOutputDelivery is in another region.	Le bucket OSS spécifié dans le paramètre OssOutputDelivery se trouve dans une région différente.
400	InvalidParameter.OssOutputDelivery	The specified parameter OssOutputDelivery is not valid.	Le paramètre OssOutputDelivery spécifié est invalide.
400	InvalidOssOutputDelivery.KeyPrefixMalformed	The prefix of the OSS key specified in the parameter OssOutputDelivery is not valid.	Le préfixe spécifié dans le paramètre OssOutputDelivery n'est pas valide.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Une erreur s'est produite lors de l'envoi de la requête. Réessayez plus tard.
403	InvalidOssOutputDelivery.BucketAccessDenied	The error message returned by the OSS API is: %s
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	Le nombre d'instances cibles dépasse la limite supérieure.
403	Invocation.ExceedQuota	The invocation quota in the current region has been reached for today.	Le nombre d'opérations d'exécution de commandes dans la région actuelle a atteint le quota du jour.
403	ParameterCount.ExceedLimit	The maximum number of parameters is exceeded.	Le nombre de paramètres personnalisés dépasse la limite.
403	ParameterKey.ExceedLimit	The maximum length of a parameter name is exceeded.	La longueur de la clé de paramètre spécifiée dépasse la longueur maximale autorisée.
403	CmdContent.ExceedLimit	The maximum length of a command is exceeded.	La longueur du contenu de la commande dépasse la limite supérieure.
403	ParameterKey.Duplicate	Parameter names cannot be duplicated.	Le nom du paramètre ne peut pas être dupliqué. Vérifiez le nom et réessayez.
403	Parameter.NotMatched	The passed-in parameters do not match the parameters defined when you created the command.	Les paramètres personnalisés transmis ne correspondent pas aux paramètres personnalisés définis lors de la création de la commande.
403	ParameterType.NotSupported	The type of parameter value is not supported.
403	Username.ExceedLimit	The length of the username exceeds the upper limit.	La longueur du nom d'utilisateur dépasse la limite supérieure.
403	WindowsPasswordName.ExceedLimit	The length of the WindowsPasswordName exceeds the upper limit.	La longueur du paramètre WindowsPasswordName spécifié dépasse la limite supérieure.
403	WindowsPasswordName.Missed	WindowsPasswordName must be specified when you create a Windows task.	La valeur du paramètre de requête WindowsPasswordName n'est pas fournie.
403	ParameterStore.NotSupported	Parameter Store is not supported in this region.
403	TemporaryAccessKey.Error	The temporary accessKey is invalid.
403	ParameterStore.InvalidParameters	The parameter is invalid in Parameter Store.	Le paramètre spécifié par {{oos:?}} dans le contenu de la commande n'a pas été trouvé.
403	ParameterStore.NoPermission	You have no access to Parameter Store.
403	Operation.Forbidden	The operation is not permitted.	L'utilisateur RAM actuel ne dispose pas des autorisations nécessaires pour effectuer cette opération.
403	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	Le jeton client spécifié a déjà été utilisé.
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	La requête idempotente précédente est toujours en cours de traitement. Réessayez plus tard.
403	InvalidLauncher.LengthLimitExceeded	The length of the parameter Launcher exceeds the limit of 1 KB characters.	La longueur du paramètre Launcher dépasse la limite de 1 Ko de caractères.
403	InvalidParameterCharset.Parameters	The parameter Parameters contains illegal charset.	Les paramètres de la commande contiennent des jeux de caractères non valides.
403	CreateServiceLinkedRole.NoPermission	You do not have permission to create ServiceLinkedRole for output delivery.	Vous n'avez pas l'autorisation de créer un rôle lié à un service pour la fonctionnalité de remise des sorties.
403	InvalidTimeout.ExceedLimit	The specified parameter Timeout exceeds the upper limit.
404	InvalidRepeatMode.NotFound	The specified repeat mode does not exist.	Le mode d'exécution de commande spécifié n'existe pas.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Les informations de région sont invalides.
404	InvalidInstance.NotFound	The specified instance does not exist.	L'instance spécifiée n'existe pas.
404	InvalidCmdId.NotFound	The specified command ID does not exist.	Le paramètre CommandId spécifié n'est pas valide. Vérifiez si la valeur du paramètre est correcte. Vous pouvez appeler l'opération DescribeCommands pour interroger toutes les valeurs CommandId disponibles.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	Le groupe de ressources correspondant est introuvable.
404	InvalidTerminationMode.NotFound	The specified parameter TerminationMode does not exist.	Le paramètre TerminationMode spécifié n'existe pas.
404	InvalidOssOutputDelivery.BucketNotFound	The OSS bucket specified in the parameter OssOutputDelivery does not exist.	Le bucket spécifié dans le paramètre OssOutputDelivery n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.