:RunCommand

Action

String

Sim

RunCommand

A operação a ser executada. Defina o valor como RunCommand.

RegionId

String

Sim

cn-hangzhou

O ID da região. Chame a operação DescribeRegions para obter a lista de regiões mais recente.

ResourceGroupId

String

Não

rg-bp67acfmxazb4p****

O ID do grupo de recursos onde o comando será executado. Ao configurar este parâmetro, observe o seguinte:

• As instâncias especificadas pelo parâmetro InstanceId.N devem pertencer a este grupo de recursos.

• Após a execução do comando, chame a operação DescribeInvocations ou DescribeInvocationResults com o parâmetro ResourceGroupId configurado para consultar os resultados de execução no grupo de recursos especificado.

Name

String

Não

testName

O nome do comando. O nome aceita todos os conjuntos de caracteres e pode ter até 128 caracteres.

Description

String

Não

testDescription

A descrição do comando. A descrição aceita todos os conjuntos de caracteres e pode ter até 512 caracteres.

Type

String

Sim

RunShellScript

O tipo de linguagem do comando. Valores válidos:

• RunBatScript: comando batch, aplicável a instâncias Windows.

• RunPowerShellScript: comando PowerShell, aplicável a instâncias Windows.

• RunShellScript: comando shell, aplicável a instâncias Linux.

CommandContent

String

Sim

ZWNobyAxMjM=

O conteúdo do comando. O conteúdo pode ser texto simples ou codificado em Base64. Observe os seguintes pontos:

• Se desejar reter o comando, garanta que o conteúdo codificado em Base64 não exceda 18 KB. Caso contrário, o limite é de 24 KB. Configure o parâmetro KeepCommand para especificar se o comando deve ser retido.

• Se o conteúdo estiver codificado em Base64, defina o parâmetro ContentEncoding como Base64.

• Se você definir o parâmetro EnableParameter como true, o recurso de parâmetros personalizados será ativado e você poderá configurar parâmetros personalizados seguindo estas regras:

  • Defina parâmetros personalizados no formato {{}}. Dentro de {{}}, espaços e quebras de linha antes e depois dos nomes dos parâmetros são ignorados.

  • É possível definir até 20 parâmetros personalizados.

  • O nome do parâmetro personalizado pode conter apenas letras, dígitos, sublinhados (_) e hifens (-). O nome não diferencia maiúsculas de minúsculas. O prefixo ACS:: não pode ser usado para especificar parâmetros de ambiente não integrados.

  • Cada nome de parâmetro personalizado não pode exceder 64 bytes.

• Parâmetros de ambiente integrados podem ser especificados como parâmetros personalizados. Durante a execução do comando, o Cloud Assistant substitui automaticamente os valores desses parâmetros. Os seguintes parâmetros de ambiente integrados estão disponíveis:

  • {{ACS::RegionId}}: o ID da região.

  • {{ACS::AccountId}}: o UID da conta Alibaba Cloud.

  • {{ACS::InstanceId}}: o ID da instância. Ao executar um comando em várias instâncias usando {{ACS::InstanceId}} como parâmetro de ambiente integrado, a versão do Cloud Assistant Agent não pode ser anterior a:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::InstanceName}}: o nome da instância. Ao executar um comando em várias instâncias usando {{ACS::InstanceName}} como parâmetro de ambiente integrado, a versão do Cloud Assistant Agent não pode ser anterior a:

    • Linux: 2.2.3.344

    • Windows: 2.1.3.344

  • {{ACS::InvokeId}}: o ID da tarefa de comando. Para usar {{ACS::InvokeId}} como parâmetro de ambiente integrado, a versão do Cloud Assistant Agent não pode ser anterior a:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::CommandId}}: o ID do comando. Para usar {{ACS::CommandId}} como parâmetro de ambiente integrado, a versão do Cloud Assistant Agent não pode ser anterior a:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

WorkingDir

String

Não

/home/user

O diretório de trabalho do comando na instância. O valor pode ter até 200 caracteres.

Valor padrão:

• Para instâncias Linux, o valor padrão é /root, que é o diretório home do administrador (usuário root).

• Para instâncias Windows, o valor padrão é o diretório onde reside o processo do Cloud Assistant Agent, como C:\Windows\System32.

Timeout

Long

Não

3600

O tempo limite para a execução do comando. Unidade: segundos.

Um erro de tempo limite ocorre se o comando não puder ser executado devido à lentidão do processo ou à ausência de um módulo específico ou do Cloud Assistant Agent. Quando a execução atinge o tempo limite, o processo do comando é encerrado forçosamente.

Valor padrão: 60.

EnableParameter

Boolean

Não

false

Especifica se parâmetros personalizados devem ser incluídos no comando.

Valor padrão: false.

RepeatMode

String

Não

Once

O modo de execução do comando. Valores válidos:

• Once: executa o comando imediatamente.

• Period: executa o comando periodicamente. Se este parâmetro for definido como Period, o parâmetro Frequency também deverá ser configurado.

• NextRebootOnly: executa o comando na próxima inicialização da instância.

• EveryReboot: executa o comando sempre que a instância for iniciada.

Valor padrão:

• Se o parâmetro Frequency não for configurado, o valor padrão será Once.

• Se o parâmetro Frequency for configurado, Period será usado como valor de RepeatMode, independentemente de o parâmetro RepeatMode estar definido como Period.

Observe os seguintes pontos:

• Chame a operação StopInvocation para interromper execuções pendentes ou agendadas do comando.

• Se este parâmetro for definido como Period ou EveryReboot, chame a operação DescribeInvocationResults com IncludeHistory definido como true para consultar os resultados de execuções agendadas históricas.

Timed

Boolean

Não

true

Frequency

String

Não

0 /20 ?

O agendamento para execução do comando. Configure o comando para ser executado em intervalos fixos usando uma expressão rate, apenas uma vez em um horário específico ou em momentos designados via expressão CRON.

• Para executar um comando em intervalos fixos, use uma expressão rate. Especifique o intervalo em segundos, minutos, horas ou dias. Esta opção é adequada para cenários que exigem execução periódica. Formato: rate(<Valor do intervalo><Unidade do intervalo>). Por exemplo, rate(5m) executa o comando a cada 5 minutos. Limites ao especificar intervalos:

  • O intervalo deve ser entre 60 segundos e 7 dias, e maior que o tempo limite da tarefa agendada.

  • O intervalo refere-se ao tempo decorrido entre duas execuções consecutivas, independentemente da duração da execução do comando. Por exemplo, com um intervalo de 5 minutos e uma execução que leva 2 minutos, o sistema aguardará 3 minutos antes de iniciar a próxima execução.

  • A tarefa não é executada imediatamente após a criação. Por exemplo, se o intervalo for de 5 minutos, a primeira execução ocorrerá 5 minutos após a criação da tarefa.

• Para executar um comando apenas uma vez em um horário específico, indique o momento e o fuso horário. Use o formato at(yyyy-MM-dd HH:mm:ss <Fuso horário>), que significa at(Ano-Mês-Dia Hora:Minuto:Segundo <Fuso horário>). Sem especificação de fuso horário, o padrão é UTC. Formatos aceitos para fuso horário:

  • Nome do fuso horário. Exemplos: Asia/Shanghai e America/Los_Angeles.

  • Deslocamento em relação ao GMT. Exemplos: GMT+8:00 (UTC+8) e GMT-7:00 (UTC-7). No formato GMT, não adicione zeros à esquerda no valor da hora.

  • Abreviação do fuso horário. Apenas UTC é suportado.

    Por exemplo, para executar um comando apenas uma vez às 13:15:30 em 6 de junho de 2022 (horário China/Shanghai), defina como at(2022-06-06 13:15:30 Asia/Shanghai). Para executar às 13:15:30 em 6 de junho de 2022 (UTC-7), defina como at(2022-06-06 13:15:30 GMT-7:00).

• Para executar um comando em horários designados, use uma expressão CRON. Formato: <Expressão CRON> <Fuso horário>, onde a expressão CRON segue o padrão <Segundos> <Minutos> <Horas> <Dia do mês> <Mês> <Dia da semana> <Ano (opcional)>. O sistema calcula os horários de execução com base na expressão CRON e no fuso horário fornecidos. Se nenhum fuso horário for especificado, o fuso horário do sistema da instância será usado. Para mais informações sobre expressões CRON, consulte Expressões CRON. Formatos aceitos para fuso horário:

  • Nome do fuso horário. Exemplos: Asia/Shanghai e America/Los_Angeles.

  • Deslocamento em relação ao GMT. Exemplos: GMT+8:00 (UTC+8) e GMT-7:00 (UTC-7). No formato GMT, não adicione zeros à esquerda no valor da hora.

  • Abreviação do fuso horário. Apenas UTC é suportado.

    Por exemplo, para executar um comando diariamente às 10:15:00 durante o ano de 2022 (horário China/Shanghai), defina como 0 15 10 ? 2022 Asia/Shanghai. Para executar a cada meia hora das 10:00:00 às 11:30:00 diariamente em 2022 (UTC+8), defina como 0 0/30 10-11 ? 2022 GMT+8:00. Para executar a cada 5 minutos das 14:00:00 às 14:55:00 diariamente, todo mês de outubro, a cada dois anos a partir de 2022 (UTC), defina como 0 0/5 14 * 10 ? 2022/2 UTC.

    Nota

    O intervalo mínimo deve ser de 10 segundos ou mais e não pode ser inferior ao tempo limite das execuções agendadas.

Parameters

Map

Não

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

Os pares chave-valor dos parâmetros personalizados transmitidos durante a execução de um comando que aceita parâmetros personalizados. Por exemplo, se o conteúdo do comando for echo {{name}}, use o parâmetro Parameters para passar o par {"name":"Jack"}. A chave name será substituída automaticamente pelo valor Jack, resultando na execução efetiva do comando echo Jack.

É possível especificar até 10 parâmetros personalizados. Observe o seguinte:

• A chave não pode ser uma string vazia e pode ter até 64 caracteres.

• O valor pode ser uma string vazia.

• Para reter o comando, garanta que o tamanho total após codificação Base64 (incluindo parâmetros personalizados e conteúdo original) não exceda 18 KB. Caso contrário, o limite é de 24 KB. Configure o parâmetro KeepCommand para definir se o comando deve ser retido.

• Os nomes dos parâmetros personalizados especificados no parâmetro Parameters devem corresponder aos nomes definidos na criação do comando. Strings vazias podem representar parâmetros não transmitidos.

Este parâmetro está vazio por padrão. Deixe-o vazio para desativar o recurso de parâmetros personalizados.

KeepCommand

Boolean

Não

false

Especifica se o comando deve ser retido após a execução. Valores válidos:

• true: retém o comando. Chame a operação InvokeCommand para executá-lo novamente. O comando retido conta para a cota de comandos do Cloud Assistant.

• false: não retém o comando. O comando é excluído automaticamente após a execução e não conta para a cota de comandos do Cloud Assistant.

Valor padrão: false.

ContentEncoding

String

Não

Base64

O modo de codificação do conteúdo especificado pelo parâmetro CommandContent. Os valores válidos não diferenciam maiúsculas de minúsculas. Valores válidos:

• PlainText: O conteúdo do comando não é codificado.

• Base64: O conteúdo do comando é codificado em Base64.

Valor padrão: PlainText. Se um valor inválido for especificado, PlainText será usado.

Username

String

Não

test

O nome de usuário para executar o comando nas instâncias. O nome de usuário pode ter até 255 caracteres.

• Para instâncias Linux, o usuário root é usado por padrão.

• Para instâncias Windows, o usuário System é usado por padrão.

Outros nomes de usuário existentes nas instâncias também podem ser especificados. Por motivos de segurança, recomendamos executar comandos do Cloud Assistant como um usuário comum. Para mais informações, consulte Executar comandos do Cloud Assistant como um usuário comum.

WindowsPasswordName

String

Não

axtSecretPassword

O nome da senha usada para executar o comando em instâncias Windows. O nome pode ter até 255 caracteres.

Se não quiser usar o usuário System padrão em instâncias Windows, configure ambos os parâmetros WindowsPasswordName e Username. A senha é armazenada em texto simples no repositório de parâmetros do CloudOps Orchestration Service (OOS) para mitigar riscos de vazamento. Apenas o nome da senha é transmitido via parâmetro WindowsPasswordName. Para mais informações, consulte Gerenciar parâmetros de criptografia e Executar comandos do Cloud Assistant como um usuário comum.

InstanceId.N

String

Sim

i-bp185dy2o3o6neg****

O ID da instância N. Valores válidos de N: 1 a 50.

Se alguma das instâncias especificadas não atender às condições de execução, a chamada falhará. Para garantir o sucesso, especifique apenas IDs de instâncias que atendam aos requisitos.

Tag.N.Key

String

Não

TestKey

A chave da tag N a ser adicionada à tarefa de comando. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia.

Ao consultar recursos com uma única tag, até 1.000 recursos com essa tag podem ser exibidos na resposta. Com múltiplas tags, até 1.000 recursos contendo todas as tags especificadas podem ser retornados. Para consultar mais de 1.000 recursos com tags específicas, chame a operação ListTagResources.

A chave da tag pode ter até 64 caracteres e não pode conter http:// ou https://. A chave não pode começar com aliyun ou acs:.

Tag.N.Value

String

Não

TestValue

O valor da tag N a ser adicionada à tarefa de comando. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia.

O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://.

ContainerId

String

Não

ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****

O ID do contêiner. Apenas strings hexadecimais de 64 bits são suportadas. IDs prefixados com docker://, containerd:// ou cri-o:// são permitidos para especificar runtimes de contêiner.

Observe os seguintes pontos:

• Se este parâmetro for configurado, o Cloud Assistant executará scripts no contêiner especificado da instância.

• Scripts só podem ser executados em instâncias Linux com o Cloud Assistant Agent instalado, versão 2.2.3.344 ou posterior.

• Quando este parâmetro é configurado, os parâmetros Username e WorkingDir perdem o efeito. O comando será executado no diretório de trabalho padrão do contêiner usando o usuário padrão do contêiner. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

• Apenas scripts shell podem ser executados em contêineres Linux. Não é possível adicionar comandos como #!/usr/bin/python no início do script para especificar um interpretador. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

ContainerName

String

Não

test-container

O nome do contêiner.

Observe os seguintes pontos:

• Se este parâmetro for configurado, o Cloud Assistant executará scripts no contêiner especificado da instância.

• Scripts só podem ser executados em instâncias Linux com o Cloud Assistant Agent instalado, versão 2.2.3.344 ou posterior.

• Quando este parâmetro é configurado, os parâmetros Username e WorkingDir perdem o efeito. O comando será executado no diretório de trabalho padrão do contêiner usando o usuário padrão do contêiner. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

• Apenas scripts shell podem ser executados em contêineres Linux. Não é possível adicionar comandos como #!/usr/bin/python no início do script para especificar um interpretador. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

ClientToken

String

Não

123e4567-e89b-12d3-a456-426655440000

O token de cliente usado para garantir a idempotência da solicitação. Gere o token no cliente, garantindo que seja único para cada solicitação. O token pode conter apenas caracteres ASCII e ter até 64 caracteres. Para mais informações, consulte Como garantir a idempotência.