Elastic Compute Service:RunCommand

O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

O ID do grupo de recursos ao qual a execução do comando pertence. Ao especificar este parâmetro:

• Se a instância ECS especificada por InstanceId pertencer a um grupo de recursos não padrão, a instância ECS deverá pertencer a este grupo de recursos.

• Você pode especificar este parâmetro para filtrar os resultados de execução de comando correspondentes chamando a operação DescribeInvocations ou DescribeInvocationResults.

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

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

O tipo de comando. Valores válidos:

• RunBatScript: Comandos Bat para instâncias Windows.

• RunPowerShellScript: Comandos PowerShell para instâncias Windows.

• RunShellScript: Comandos Shell para instâncias Linux.

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

• O tamanho do conteúdo do comando codificado em Base64 não pode exceder 24 KB. Você pode usar KeepCommand para especificar se deve reter o comando.

• Se o conteúdo do comando for codificado em Base64, você deve definir ContentEncoding como Base64.

• Se você definir EnableParameter como true, o recurso de parâmetro personalizado será ativado no conteúdo do comando:

  • Use {{}} para envolver parâmetros personalizados. Espaços e quebras de linha antes e depois dos nomes dos parâmetros dentro de {{}} são ignorados.

  • Você pode definir até 20 parâmetros personalizados.

  • Um nome de parâmetro personalizado pode conter letras, dígitos, hifens (-) e sublinhados (_). O prefixo acs:: não é suportado para especificar variáveis de ambiente não integradas. Outros caracteres não são suportados. Os nomes dos parâmetros não diferenciam maiúsculas de minúsculas.

  • Um único nome de parâmetro personalizado não pode exceder 64 bytes de comprimento.

• Você pode especificar variáveis de ambiente integradas como parâmetros personalizados. Ao executar o comando, você não precisa atribuir valores manualmente aos parâmetros. O Cloud Assistant os substitui automaticamente pelos valores correspondentes no ambiente. As seguintes variáveis de ambiente integradas são suportadas:

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

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

  • {{ACS::InstanceId}}: o ID da instância. Se o comando for enviado para várias instâncias e você quiser especificar {{ACS::InstanceId}} como uma variável de ambiente integrada, certifique-se de que o Cloud Assistant Agent seja das seguintes versões ou posterior:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::InstanceName}}: o nome da instância. Se o comando for enviado para várias instâncias e você quiser especificar {{ACS::InstanceName}} como uma variável de ambiente integrada, certifique-se de que o Cloud Assistant Agent seja das seguintes versões ou posterior:

    • Linux: 2.2.3.344

    • Windows: 2.1.3.344

  • {{ACS::InvokeId}}: o ID da invocação. Se você quiser especificar {{ACS::InvokeId}} como uma variável de ambiente integrada, certifique-se de que o Cloud Assistant Agent seja das seguintes versões ou posterior:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::CommandId}}: o ID do comando. Se você chamar esta operação para executar um comando e quiser especificar {{ACS::CommandId}} como uma variável de ambiente integrada, certifique-se de que o Cloud Assistant Agent seja das seguintes versões ou posterior:

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

O diretório de execução do comando na instância ECS. Pode ter até 200 caracteres de comprimento.

Valor padrão:

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

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

O período de tempo limite para a execução do comando. Unidade: segundos.

Se o comando não puder ser executado devido a problemas de processo, módulos ausentes ou Cloud Assistant Agent ausente, ocorrerá um tempo limite. Após um tempo limite, o processo do comando é encerrado à força.

Valor padrão: 60.

Especifica se o comando contém parâmetros personalizados.

Valor padrão: false.

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

• Once: executa o comando imediatamente.

• Period: executa o comando em uma programação. Se você definir este parâmetro como Period, também deverá especificar o parâmetro Frequency.

• NextRebootOnly: executa automaticamente o comando na próxima vez que a instância for iniciada.

• EveryReboot: executa automaticamente o comando toda vez que a instância for iniciada.

• DryRun: apenas pré-verifica a solicitação. A execução do comando não entra em vigor. Os itens de verificação incluem parâmetros de solicitação, ambiente de execução da instância e status de execução do Cloud Assistant Agent.

Valor padrão:

• Se você não especificar o parâmetro Frequency, o valor padrão é Once.

• Se você especificar o parâmetro Frequency, o valor será processado como Period, independentemente de este parâmetro estar definido ou não.

Precauções:

• Você pode chamar a operação StopInvocation para interromper um comando pendente ou um comando agendado.

• Se você definir este parâmetro como Period ou EveryReboot, poderá chamar a operação DescribeInvocationResults e definir IncludeHistory=true para visualizar os registros históricos da execução do comando agendado.

[Deprecated] Este parâmetro foi descontinuado e não tem efeito mesmo se for especificado.

O horário de execução do comando agendado. Três modos de execução agendada são suportados: execução em intervalos fixos (com base em expressões Rate), execução única em um horário especificado e execução agendada baseada em relógio (com base em expressões Cron).

• Execução em intervalos fixos: executa o comando no intervalo de tempo especificado com base em uma expressão Rate. O intervalo de tempo pode ser especificado em segundos (s), minutos (m), horas (h) ou dias (d). Este modo é adequado para cenários em que as tarefas são executadas em intervalos fixos. O formato é rate(). Por exemplo, para executar o comando a cada 5 minutos, o formato é rate(5m). Os seguintes limites se aplicam à execução em intervalos fixos:

  • O intervalo de tempo especificado não deve exceder 7 dias, não deve ser inferior a 60 segundos e deve ser maior que o período de tempo limite da tarefa agendada.

  • O intervalo de execução é baseado apenas na frequência fixa e é independente do tempo real necessário para executar a tarefa. Por exemplo, se você definir o comando para ser executado a cada 5 minutos e a tarefa levar 2 minutos para ser concluída, a próxima execução começará 3 minutos após a conclusão da tarefa.

  • A tarefa não é executada imediatamente após a criação. Por exemplo, se você definir o comando para ser executado a cada 5 minutos, o comando não será executado imediatamente após a criação da tarefa. Em vez disso, a execução começa 5 minutos após a criação da tarefa.

• Execução única em um horário especificado: executa o comando uma vez no fuso horário e ponto de tempo especificados. 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>). Se você não especificar um fuso horário, o fuso horário UTC será usado por padrão. O fuso horário suporta os seguintes três formatos:

  • Nome completo do fuso horário: como Asia/Shanghai (hora de China/Xangai) e America/Los_Angeles (hora de EUA/Los Angeles).

  • Deslocamento do fuso horário em relação ao Horário de Greenwich: como GMT+8:00 (8ª zona leste) e GMT-7:00 (7ª zona oeste). Ao usar o formato GMT, zeros à esquerda não são suportados para o dígito da hora.

  • Abreviatura do fuso horário: apenas UTC (Tempo Universal Coordenado) é suportado.

  Por exemplo, para executar o comando uma vez às 13:15:30 em 6 de junho de 2022 no fuso horário China/Xangai, o formato é at(2022-06-06 13:15:30 Asia/Shanghai). Para executar o comando uma vez às 13:15:30 em 6 de junho de 2022 na 7ª zona oeste, o formato é at(2022-06-06 13:15:30 GMT-7:00).

• Execução agendada baseada em relógio (com base em expressões Cron): executa o comando com base em uma expressão Cron. O formato é <dia do mês> <mês> <ano (opcional)> <fuso horário>, que significa <expressão Cron> <fuso horário>. No fuso horário especificado, o horário de execução da tarefa agendada é calculado com base na expressão Cron e a tarefa é executada. Se você não especificar um fuso horário, o fuso horário do sistema interno da instância que executa a tarefa agendada será usado por padrão. Para mais informações sobre expressões Cron, consulte Expressões Cron. O fuso horário suporta os seguintes três formatos:

  • Nome completo do fuso horário: como Asia/Shanghai (hora de China/Xangai) e America/Los_Angeles (hora de EUA/Los Angeles).

  • Deslocamento do fuso horário em relação ao Horário de Greenwich: como GMT+8:00 (8ª zona leste) e GMT-7:00 (7ª zona oeste). Ao usar o formato GMT, zeros à esquerda não são suportados para o dígito da hora.

  • Abreviatura do fuso horário: apenas UTC (Tempo Universal Coordenado) é suportado. Por exemplo, para executar o comando uma vez às 10:15 todos os dias em 2022 no fuso horário China/Xangai, o formato é 0 15 10 ? * * 2022 Asia/Shanghai. Para executar o comando a cada meia hora das 10:00 às 11:30 todos os dias em 2022 na 8ª zona leste, o formato é 0 0/30 10-11 * * ? 2022 GMT+8:00. Para executar o comando a cada 5 minutos das 14:00 às 14:55 todos os dias em outubro a cada dois anos a partir de 2022 no fuso horário UTC, o formato é 0 0/5 14 * 10 ? 2022/2 UTC.

  Nota

  O intervalo de tempo mínimo deve ser maior ou igual ao período de tempo limite da tarefa agendada e não deve ser inferior a 10 segundos.

Os pares chave-valor de parâmetros personalizados passados quando o comando é executado, se o comando contiver parâmetros personalizados. Por exemplo, se o conteúdo do comando for echo {{name}}, você pode passar o par chave-valor {"name":"Jack"} usando o parâmetro Parameter. O parâmetro personalizado substitui automaticamente o valor da variável name, resultando em um novo comando. O comando real executado é echo Jack.

O número de parâmetros personalizados varia de 0 a 10. Observe os seguintes itens:

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

• O valor pode ser uma string vazia.

• Após os parâmetros personalizados e o conteúdo original do comando serem codificados em Base64, o tamanho do conteúdo do comando codificado em Base64 não pode exceder 24 KB. Você pode usar KeepCommand para especificar se deve reter o comando.

• O conjunto de nomes de parâmetros personalizados deve ser um subconjunto do conjunto de parâmetros definido quando o comando é criado. Para parâmetros que não são passados, você pode usar uma string vazia em seu lugar.

Valor padrão: vazio. Isso significa que o parâmetro não está definido e os parâmetros personalizados estão desativados.

Especifica se deve reter o comando após sua execução. Valores válidos:

• true: retém o comando. Você pode chamar a operação InvokeCommand para executá-lo novamente. Isso consome a cota para comandos retidos do Cloud Assistant.

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

Valor padrão: false.

O modo de codificação do conteúdo do comando (CommandContent). Valores válidos (não diferencia maiúsculas de minúsculas):

• PlainText: sem codificação. O conteúdo é transmitido em texto simples.

• Base64: codificação Base64.

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

O nome de usuário do usuário que executa o comando na instância ECS. Pode ter até 255 caracteres de comprimento.

• Para instâncias ECS Linux, o comando é executado pelo usuário root por padrão.

• Para instâncias ECS Windows, o comando é executado pelo usuário System por padrão.

Você também pode especificar outro usuário existente na instância para executar o comando. Executar comandos do Cloud Assistant como um usuário comum é mais seguro. Para mais informações, consulte Configurar um usuário comum para executar comandos do Cloud Assistant.

O nome da senha do usuário que executa o comando na instância Windows. Pode ter até 255 caracteres de comprimento.

Se você quiser executar o comando como um usuário não padrão (System) em uma instância Windows, deverá especificar tanto Username quanto este parâmetro. Para reduzir o risco de vazamento de senha, você deve hospedar a senha em texto simples no repositório de parâmetros do gerenciamento de operações e passar apenas o nome da senha aqui. Para mais informações, consulte Parâmetros criptografados e Configurações para usuários comuns executarem comandos do Cloud Assistant.

O ID do contêiner. Apenas strings hexadecimais de 64 bits são suportadas. O prefixo docker://, containerd:// ou cri-o:// é permitido para especificar explicitamente o tempo de execução do contêiner.

Precauções:

• Se você especificar este parâmetro, o Cloud Assistant executará o script no contêiner especificado na instância.

• Se você especificar este parâmetro, ele será suportado apenas em instâncias Linux onde a versão do Cloud Assistant Agent é 2.2.3.344 ou posterior.

• Se você especificar este parâmetro, os parâmetros Username e WorkingDir especificados não terão efeito. O comando só pode ser executado pelo usuário padrão do contêiner no diretório de trabalho padrão do contêiner. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

O nome do contêiner.

Precauções:

• Se você especificar este parâmetro, o Cloud Assistant executará o script no contêiner especificado na instância.

• Se você especificar este parâmetro, ele será suportado apenas em instâncias Linux onde a versão do Cloud Assistant Agent é 2.2.3.344 ou posterior.

• Se você especificar este parâmetro, os parâmetros Username e WorkingDir especificados não terão efeito. O comando só pode ser executado pelo usuário padrão do contêiner no diretório de trabalho padrão do contêiner. Para mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.

O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O valor ClientToken pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para mais informações, consulte Como garantir a idempotência.

A configuração de entrega do OSS para a saída da execução do comando.

• Formato: oss://${BucketName}/${Prefix}. ${BucketName} é o nome do bucket do OSS para o qual a saída é entregue, e ${Prefix} é o prefixo do diretório para o qual a saída é entregue.

O modo usado quando a tarefa é interrompida (interrompida manualmente ou interrompida devido ao tempo limite de execução). Valores válidos:

• Process: interrompe o processo do script atual.

• ProcessTree: interrompe a árvore de processos atual (o processo do script e todos os processos filho criados por ele).

O programa de inicialização para execução do script. Não pode exceder 1 KB de comprimento.