:RunCommand

Action

String

Yes

RunCommand

Opération à exécuter. Définissez la valeur sur RunCommand.

RegionId

String

Yes

cn-hangzhou

ID de la région. Appelez l’opération DescribeRegions pour obtenir la liste des régions les plus récentes.

ResourceGroupId

String

No

rg-bp67acfmxazb4p****

ID du groupe de ressources dans lequel vous souhaitez exécuter la commande. Lors de la configuration de ce paramètre, tenez compte des éléments suivants :

• Les instances spécifiées par le paramètre InstanceId.N doivent appartenir à ce groupe de ressources.

• Une fois la commande exécutée, appelez l’opération DescribeInvocations ou DescribeInvocationResults avec le paramètre ResourceGroupId configuré afin d’interroger les résultats d’exécution dans le groupe de ressources spécifié.

Name

String

No

testName

Nom de la commande. Le nom prend en charge tous les jeux de caractères et peut comporter jusqu’à 128 caractères.

Description

String

No

testDescription

Description de la commande. La description prend en charge tous les jeux de caractères et peut comporter jusqu’à 512 caractères.

Type

String

Yes

RunShellScript

Type de langage de la commande. Valeurs possibles :

• RunBatScript : commande batch, applicable aux instances Windows.

• RunPowerShellScript : commande PowerShell, applicable aux instances Windows.

• RunShellScript : commande shell, applicable aux instances Linux.

CommandContent

String

Yes

ZWNobyAxMjM=

Contenu de la commande. Le contenu peut être en texte brut ou encodé en Base64. Tenez compte des éléments suivants :

• Si vous souhaitez conserver la commande, assurez-vous que le contenu encodé en Base64 ne dépasse pas 18 Ko. Si vous ne souhaitez pas conserver la commande, assurez-vous que le contenu encodé en Base64 ne dépasse pas 24 Ko. Utilisez le paramètre KeepCommand pour indiquer si la commande doit être conservée.

• Si le contenu de la commande est encodé en Base64, définissez le paramètre ContentEncoding sur Base64.

• Si vous définissez le paramètre EnableParameter sur true, la fonctionnalité de paramètres personnalisés est activée et vous pouvez configurer des paramètres personnalisés selon les règles suivantes :

  • Définissez les paramètres personnalisés au format {{}}. À l’intérieur de {{}}, les espaces et les sauts de ligne avant et après les noms des paramètres sont ignorés.

  • Vous pouvez définir jusqu’à 20 paramètres personnalisés.

  • Un nom de paramètre personnalisé ne peut contenir que des lettres, des chiffres, des traits de soulignement (_) et des traits d’union (-). La casse n’est pas prise en compte. Le préfixe ACS:: ne peut pas être utilisé pour spécifier des paramètres d’environnement non intégrés.

  • Chaque nom de paramètre personnalisé ne peut pas dépasser 64 octets.

• Vous pouvez spécifier des paramètres d’environnement intégrés en tant que paramètres personnalisés. Lors de l’exécution d’une commande, Cloud Assistant remplace automatiquement les valeurs de ces paramètres. Vous pouvez spécifier les paramètres d’environnement intégrés suivants :

  • {{ACS::RegionId}} : ID de la région.

  • {{ACS::AccountId}} : UID du compte Alibaba Cloud.

  • {{ACS::InstanceId}} : ID de l’instance. Lorsqu’une commande est exécutée sur plusieurs instances, si vous souhaitez spécifier {{ACS::InstanceId}} comme paramètre d’environnement intégré, assurez-vous que la version de Cloud Assistant Agent n’est pas antérieure aux versions suivantes :

    • Linux : 2.2.3.309

    • Windows : 2.1.3.309

  • {{ACS::InstanceName}} : nom de l’instance. Lorsqu’une commande est exécutée sur plusieurs instances, si vous souhaitez spécifier {{ACS::InstanceName}} comme paramètre d’environnement intégré, assurez-vous que la version de Cloud Assistant Agent n’est pas antérieure aux versions suivantes :

    • Linux : 2.2.3.344

    • Windows : 2.1.3.344

  • {{ACS::InvokeId}} : ID de la tâche de commande. Si vous souhaitez spécifier {{ACS::InvokeId}} comme paramètre d’environnement intégré, assurez-vous que la version de Cloud Assistant Agent n’est pas antérieure aux versions suivantes :

    • Linux : 2.2.3.309

    • Windows : 2.1.3.309

  • {{ACS::CommandId}} : ID de la commande. Si vous souhaitez spécifier {{ACS::CommandId}} comme paramètre d’environnement intégré, assurez-vous que la version de Cloud Assistant Agent n’est pas antérieure aux versions suivantes :

    • Linux : 2.2.3.309

    • Windows : 2.1.3.309

WorkingDir

String

No

/home/user

Répertoire de travail de la commande sur l’instance. La valeur peut comporter jusqu’à 200 caractères.

Valeur par défaut :

• Pour les instances Linux, la valeur par défaut est /root, qui correspond au répertoire personnel de l’administrateur (utilisateur root).

• Pour les instances Windows, la valeur par défaut est le répertoire où réside le processus Cloud Assistant Agent, par exemple C:\Windows\System32.

Timeout

Long

No

3600

Délai d’expiration de l’exécution de la commande. Unité : secondes.

Une erreur de délai d’expiration se produit si la commande ne peut pas être exécutée en raison d’un ralentissement du processus ou de l’absence d’un module spécifique ou de Cloud Assistant Agent. En cas d’expiration du délai, le processus de commande est arrêté de force.

Valeur par défaut : 60.

EnableParameter

Boolean

No

false

Indique s’il faut inclure des paramètres personnalisés dans la commande.

Valeur par défaut : false.

RepeatMode

String

No

Once

Mode d’exécution de la commande. Valeurs possibles :

• Once : exécute immédiatement la commande.

• Period : exécute la commande périodiquement. Si vous définissez ce paramètre sur Period, vous devez également configurer le paramètre Frequency.

• NextRebootOnly : exécute la commande lors du prochain démarrage de l’instance.

• EveryReboot : exécute la commande à chaque démarrage de l’instance.

Valeur par défaut :

• Si vous ne configurez pas le paramètre Frequency, la valeur par défaut est Once.

• Si vous configurez le paramètre Frequency, Period est utilisé comme valeur de RepeatMode, que le paramètre RepeatMode soit défini sur Period ou non.

Tenez compte des éléments suivants :

• Appelez l’opération StopInvocation pour arrêter les exécutions en attente ou planifiées de la commande.

• Si vous définissez ce paramètre sur Period ou EveryReboot, appelez l’opération DescribeInvocationResults avec IncludeHistory défini sur true pour interroger les résultats des exécutions planifiées historiques.

Timed

Boolean

No

true

Fréquence

String

Non

0 /20 ?

La planification selon laquelle vous souhaitez exécuter la commande. Vous pouvez configurer une commande pour qu'elle s'exécute à un intervalle fixe basé sur une expression de taux, une seule fois à un moment spécifié ou à des moments désignés basés sur une expression CRON.

• Pour exécuter une commande à un intervalle fixe, utilisez une expression de taux pour spécifier l'intervalle. Vous pouvez spécifier l'intervalle en secondes, minutes, heures ou jours. Cette option convient aux scénarios dans lesquels les tâches doivent être exécutées à un intervalle fixe. Spécifiez l'intervalle au format suivant : rate(<Valeur de l'intervalle d'exécution><Unité de l'intervalle d'exécution>). Par exemple, spécifiez rate(5m) pour exécuter la commande toutes les 5 minutes. Lorsque vous spécifiez un intervalle, tenez compte des limites suivantes :

  • L'intervalle peut aller de 60 secondes à 7 jours, mais doit être supérieur à la période de délai d'expiration de la tâche planifiée.

  • L'intervalle correspond au temps qui s'écoule entre deux exécutions consécutives. L'intervalle n'a aucun rapport avec le temps nécessaire pour exécuter la commande une fois. Par exemple, si vous définissez l'intervalle sur 5 minutes et que l'exécution de la commande prend 2 minutes à chaque fois, le système attend 3 minutes avant d'exécuter à nouveau la commande.

  • Une tâche n'est pas exécutée immédiatement après sa création. Par exemple, si vous définissez l'intervalle sur 5 minutes pour une tâche, celle-ci commence à s'exécuter 5 minutes après sa création.

• Pour exécuter une commande une seule fois à un moment précis, spécifiez un instant et un fuseau horaire. Indiquez l'instant au format at(yyyy-MM-dd HH:mm:ss <Fuseau horaire>), ce qui correspond à at(Année-Mois-Jour Heure:Minute:Seconde <Fuseau horaire>). Si vous ne spécifiez pas de fuseau horaire, le fuseau horaire par défaut est UTC. Vous pouvez spécifier un fuseau horaire sous les formes suivantes :

  • Le nom du fuseau horaire. Exemples : Asia/Shanghai et America/Los_Angeles.

  • Le décalage horaire par rapport à GMT. Exemples : GMT+8:00 (UTC+8) et GMT-7:00 (UTC-7). Si vous utilisez le format GMT, n'ajoutez pas de zéros non significatifs à la valeur de l'heure.

  • L'abréviation du fuseau horaire. Seule l'abréviation UTC est prise en charge.

    Par exemple, pour configurer une commande afin qu'elle s'exécute une seule fois le 6 juin 2022 à 13:15:30 (heure de Chine/Shanghai), définissez l'heure sur at(2022-06-06 13:15:30 Asia/Shanghai). Pour configurer une commande afin qu'elle s'exécute une seule fois le 6 juin 2022 à 13:15:30 (UTC-7), définissez l'heure sur at(2022-06-06 13:15:30 GMT-7:00).

• Pour exécuter une commande à des moments désignés, spécifiez une expression CRON. Indiquez l'heure au format suivant : <Expression CRON> <Fuseau horaire>, où l'expression CRON est au format <Secondes> <Minutes> <Heures> <Jour du mois> <Mois> <Jour de la semaine> <Année (facultatif)>. Le système calcule les heures d'exécution de la commande en fonction de l'expression CRON et du fuseau horaire spécifiés, puis exécute la commande selon la planification. Si vous ne spécifiez pas de fuseau horaire, le fuseau horaire du système de l'instance sur laquelle vous souhaitez exécuter la commande est utilisé par défaut. Pour plus d'informations sur les expressions CRON, consultez la rubrique Expressions CRON. Vous pouvez spécifier un fuseau horaire sous les formes suivantes :

  • Le nom du fuseau horaire. Exemples : Asia/Shanghai et America/Los_Angeles.

  • Le décalage horaire par rapport à GMT. Exemples : GMT+8:00 (UTC+8) et GMT-7:00 (UTC-7). Si vous utilisez le format GMT, n'ajoutez pas de zéros non significatifs à la valeur de l'heure.

  • L'abréviation du fuseau horaire. Seule l'abréviation UTC est prise en charge.

    Par exemple, pour configurer une commande afin qu'elle s'exécute tous les jours à 10:15:00 en 2022 (heure de Chine/Shanghai), définissez l'heure sur 0 15 10 ? 2022 Asia/Shanghai. Pour configurer une commande afin qu'elle s'exécute toutes les demi-heures de 10:00:00 à 11:30:00 tous les jours en 2022 (UTC+8), définissez l'heure sur 0 0/30 10-11 ? 2022 GMT+8:00. Pour configurer une commande afin qu'elle s'exécute toutes les 5 minutes de 14:00:00 à 14:55:00 tous les jours, chaque année en octobre, tous les deux ans depuis 2022 (UTC), définissez l'heure sur 0 0/5 14 * 10 ? 2022/2 UTC.

    Remarque

    L'intervalle minimal doit être d'au moins 10 secondes et ne peut pas être inférieur à la période de délai d'expiration des exécutions planifiées.

Parameters

Map

Non

{"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"}

Les paires clé-valeur des paramètres personnalisés transmis lors de l'exécution de la commande pouvant inclure des paramètres personnalisés. Par exemple, si le contenu de la commande est echo {{name}}, vous pouvez utiliser le paramètre Parameters pour transmettre la paire clé-valeur {"name":"Jack"}. La clé name du paramètre personnalisé est automatiquement remplacée par la valeur Jack associée pour générer une nouvelle commande. Par conséquent, la commande echo Jack est effectivement exécutée.

Vous pouvez spécifier jusqu'à 10 paramètres personnalisés. Tenez compte des points suivants :

• La clé ne peut pas être une chaîne vide. Sa longueur maximale est de 64 caractères.

• La valeur peut être une chaîne vide.

• Si vous souhaitez conserver la commande, assurez-vous que la commande après encodage Base64, y compris les paramètres personnalisés et le contenu de la commande d'origine, ne dépasse pas 18 Ko. Si vous ne souhaitez pas conserver la commande, assurez-vous que la commande après encodage Base64 ne dépasse pas 24 Ko. Vous pouvez configurer le paramètre KeepCommand pour spécifier si la commande doit être conservée.

• Les noms des paramètres personnalisés spécifiés par le paramètre Parameters doivent être inclus dans les noms des paramètres personnalisés que vous avez spécifiés lors de la création de la commande. Vous pouvez utiliser des chaînes vides pour représenter les paramètres qui ne sont pas transmis.

Ce paramètre est vide par défaut. Vous pouvez laisser ce paramètre vide pour désactiver la fonctionnalité de paramètre personnalisé.

KeepCommand

Boolean

Non

false

Indique s'il faut conserver la commande après son exécution. Valeurs valides :

• true : conserve la commande. Vous pouvez appeler l'opération InvokeCommand pour réexécuter la commande. La commande conservée est comptabilisée dans le quota des commandes Cloud Assistant.

• false : ne conserve pas la commande. La commande est automatiquement supprimée après son exécution et n'est pas comptabilisée dans le quota des commandes Cloud Assistant.

Valeur par défaut : false.

ContentEncoding

String

Non

Base64

Le mode d'encodage du contenu de la commande spécifié par le paramètre CommandContent. Les valeurs valides ne sont pas sensibles à la casse. Valeurs valides :

• PlainText : le contenu de la commande n'est pas encodé.

• Base64 : le contenu de la commande est encodé en Base64.

Valeur par défaut : PlainText. Si une valeur non valide est spécifiée pour ce paramètre, PlainText est utilisé.

Username

String

Non

test

Le nom d'utilisateur à utiliser pour exécuter la commande sur les instances. La longueur du nom d'utilisateur ne peut pas dépasser 255 caractères.

• Pour les instances Linux, le nom d'utilisateur root est utilisé par défaut.

• Pour les instances Windows, le nom d'utilisateur System est utilisé par défaut.

Vous pouvez également spécifier d'autres noms d'utilisateurs existant déjà dans les instances pour exécuter la commande. Pour des raisons de sécurité, nous vous recommandons d'exécuter les commandes Cloud Assistant en tant qu'utilisateur standard. Pour plus d'informations, consultez la rubrique Exécuter des commandes Cloud Assistant en tant qu'utilisateur standard.

WindowsPasswordName

String

Non

axtSecretPassword

Le nom du mot de passe à utiliser pour exécuter la commande sur les instances Windows. La longueur du nom ne peut pas dépasser 255 caractères.

Si vous ne souhaitez pas utiliser l'utilisateur System par défaut pour exécuter la commande sur les instances Windows, configurez les paramètres WindowsPasswordName et Username. Le mot de passe est stocké en texte clair dans le référentiel de paramètres de CloudOps Orchestration Service (OOS) afin de réduire le risque de fuite de mot de passe. Seul le nom du mot de passe est transmis via le paramètre WindowsPasswordName. Pour plus d'informations, consultez les rubriques Gérer les paramètres de chiffrement et Exécuter des commandes Cloud Assistant en tant qu'utilisateur standard.

InstanceId.N

String

Oui

i-bp185dy2o3o6neg****

ID de l'instance N. Valeurs valides pour N : 1 à 50.

Si l'une des instances spécifiées ne répond pas aux conditions requises pour l'exécution de la commande, l'appel échoue. Pour garantir la réussite de l'appel, spécifiez uniquement les ID des instances qui répondent aux conditions.

Tag.N.Key

String

Non

TestKey

Clé du tag N à ajouter à la tâche de commande. Valeurs valides pour N : 1 à 20. La clé du tag ne peut pas être une chaîne vide.

Si un seul tag est spécifié pour interroger des resources, un maximum de 1 000 resources ayant ce tag peuvent être affichées dans la réponse. Si plusieurs tags sont spécifiés pour interroger des resources, un maximum de 1 000 resources ayant tous ces tags peuvent être affichées dans la réponse. Pour interroger plus de 1 000 resources ayant des tags spécifiés, appelez l'opération ListTagResources.

La longueur de la clé du tag peut atteindre 64 caractères et ne peut pas contenir http:// ni https://. La clé du tag ne peut pas commencer par aliyun ou acs:.

Tag.N.Value

String

Non

TestValue

Valeur du tag N à ajouter à la tâche de commande. Valeurs valides pour N : 1 à 20. La valeur du tag peut être une chaîne vide.

La longueur de la valeur du tag peut atteindre 128 caractères et ne peut pas contenir http:// ni https://.

ContainerId

String

Non

ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****

ID du conteneur. Seules les chaînes hexadécimales 64 bits sont prises en charge. Les ID de conteneur préfixés par docker://, containerd:// ou cri-o:// permettent de spécifier des environnements d'exécution de conteneurs.

Tenez compte des points suivants :

• Si ce paramètre est configuré, Cloud Assistant exécute des scripts dans le conteneur spécifié de l'instance.

• Si ce paramètre est configuré, les scripts ne peuvent être exécutés que sur des instances Linux sur lesquelles Cloud Assistant Agent est installé. La version de Cloud Assistant Agent doit être 2.2.3.344 ou ultérieure.

• Si ce paramètre est configuré, les paramètres Username et WorkingDir configurés ne prennent pas effet. Vous pouvez exécuter la commande dans le répertoire de travail par défaut du conteneur uniquement en utilisant l'utilisateur par défaut du conteneur. Pour plus d'informations, consultez la rubrique Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs.

• Si ce paramètre est configuré, seuls les scripts shell peuvent être exécutés dans les conteneurs Linux. Vous ne pouvez pas ajouter une commande au format similaire à #!/usr/bin/python au début d'un script pour spécifier un interpréteur de script. Pour plus d'informations, consultez la rubrique Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs.

ContainerName

String

No

test-container

Le nom du conteneur.

Tenez compte des points suivants :

• Si ce paramètre est configuré, Cloud Assistant exécute les scripts dans le conteneur spécifié de l'instance.

• Si ce paramètre est configuré, les scripts peuvent être exécutés uniquement sur les instances Linux sur lesquelles Cloud Assistant Agent est installé. La version de Cloud Assistant Agent doit être la 2.2.3.344 ou ultérieure.

• Si ce paramètre est configuré, les paramètres Username et WorkingDir configurés ne prennent pas effet. Vous pouvez exécuter la commande dans le répertoire de travail par défaut du conteneur uniquement en utilisant l'utilisateur par défaut du conteneur. Pour plus d'informations, consultez Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs.

• Si ce paramètre est configuré, seuls les scripts shell peuvent être exécutés dans les conteneurs Linux. Vous ne pouvez pas ajouter une commande au format similaire à #!/usr/bin/python au début d'un script pour spécifier un interpréteur de script. Pour plus d'informations, consultez Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs.

ClientToken

String

No

123e4567-e89b-12d3-a456-426655440000

Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique parmi différentes requêtes. Le jeton peut contenir uniquement des caractères ASCII et ne peut pas dépasser 64 caractères de longueur. Pour plus d'informations, consultez Comment garantir l'idempotence.