Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::ECS::Invocation

Última atualização: Sep 21, 2026

ALIYUN::ECS::Invocation executa um comando do Cloud Assistant em instâncias do Elastic Compute Service (ECS).

Sintaxe

{
  "Type": "ALIYUN::ECS::Invocation",
  "Properties": {
    "Frequency": String,
    "CommandId": String,
    "Parameters": Map,
    "InstanceIds": List,
    "Sync": Boolean,
    "CommandName": String,
    "WindowsPasswordName": String,
    "Timeout": Integer,
    "RepeatMode": String,
    "ResourceGroupId": String,
    "ContainerName": String,
    "ContainerId": String,
    "Launcher": String,
    "Username": String,
    "Tags": List
  }
}

Propriedades

Property

Type

Required

Editable

Description

Constraint

Frequency

String

No

No

A agenda de execução do comando. Para informações sobre as estruturas de valor, consulte Cron expression.

Nenhuma.

CommandId

String

No

Yes

O id do comando.

Nenhuma.

InstanceIds

List

Yes

Yes

Os IDs das instâncias ECS nas quais o comando será executado.

Especifique até 20 IDs de instância.

Parameters

Map

No

Yes

Os pares chave-valor dos parâmetros personalizados a serem passados ao comando quando o recurso de parâmetros personalizados está ativado. Exemplo: {"name": "Jack", "accessKey": "LTAI"}.

Especifique até 10 parâmetros personalizados.

Nenhuma chave em uma coleção Map pode ser uma string vazia; cada chave pode ter no máximo 64 caracteres. Cada valor em uma coleção Map pode ser uma string vazia.

Após a codificação em Base64 dos parâmetros personalizados e do conteúdo original do comando, o tamanho total não pode ultrapassar 16 KB.

O conjunto de nomes de parâmetros personalizados deve ser um subconjunto do conjunto de parâmetros definido ao criar o comando. Use strings vazias para representar os parâmetros não informados.

Sync

Boolean

No

No

Define se o comando deve ser executado de forma síncrona.

Valores válidos:

  • true

  • false

Launcher

String

No

No

O launcher para a execução do script.

O valor pode ter no máximo 1 KB.

CommandName

String

No

No

O nome do comando.

Nenhuma.

WindowsPasswordName

String

No

No

O nome de usuário da senha utilizada para executar o comando em instâncias Windows.

O nome pode ter no máximo 255 caracteres.

Para não usar o usuário padrão do sistema ao executar o comando em instâncias Windows, especifique as propriedades WindowsPasswordName e Username. A senha é armazenada em texto simples no repositório de parâmetros do CloudOps Orchestration Service (OOS) para reduzir o risco de vazamento. Somente o nome de usuário da senha é transmitido por meio da propriedade WindowsPasswordName. Para mais informações, consulte Encrypted parameters e Run Cloud Assistant commands as a regular user.

Nota

Ao usar o usuário root em instâncias Linux ou o usuário System em instâncias Windows para executar o comando, não é necessário especificar a propriedade WindowsPasswordName.

Timeout

Integer

No

Yes

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

Observe os seguintes pontos ao especificar esta propriedade:

  • O período de tempo limite não pode ser inferior a 10 segundos.

  • Um erro de tempo limite ocorre quando o comando não pode ser executado em decorrência de lentidão no processo ou porque um módulo específico ou o Cloud Assistant Agent não existe. Ao fim do período especificado, o processo do comando é encerrado à força.

  • Se esta propriedade não for especificada, o período de tempo limite definido durante a criação do comando será utilizado.

  • Este período de tempo limite aplica-se somente à execução em questão. O período de tempo limite do comando não é alterado.

RepeatMode

String

No

No

O modo de execução do comando.

Valores válidos:

  • Once: executa o comando imediatamente.

  • Period: executa o comando periodicamente. Ao defina esta propriedade como Period, especifique também a propriedade Frequency.

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

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

Valores padrão:

  • Se a propriedade Frequency não for especificada, o valor padrão é Once.

  • Se a propriedade Frequency for especificada, Period será usado como valor de RepeatMode, independentemente de a propriedade RepeatMode ter sido definida como Period.

Observe os seguintes pontos ao especificar esta propriedade:

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

  • Ao defina esta propriedade como Period ou EveryReboot, chame a operação DescribeInvocationResults com IncludeHistory definido como true para consultar os resultados de execuções agendadas anteriores.

ResourceGroupId

String

No

No

O id do grupo de recursos.

Observe os seguintes pontos ao especificar esta propriedade:

  • A instância ECS especificada por InstanceId deve pertencer ao grupo de recursos.

  • Após a execução do comando, chame a operação DescribeInvocations ou DescribeInvocationResults e especifique ResourceGroupId para consultar os resultados de execução do comando no grupo de recursos indicado.

ContainerName

String

No

No

O nome do container.

Observe os seguintes pontos ao especificar esta propriedade:

  • Com esta propriedade definida, o Cloud Assistant executa scripts no container indicado na instância.

  • Com esta propriedade definida, os scripts só podem ser executados em instâncias Linux com o Cloud Assistant Agent instalado. A versão do Cloud Assistant Agent deve ser 2.2.3.344 ou posterior.

  • Com esta propriedade definida, Username informado na solicitação desta operação e WorkingDir informado na solicitação da operação CreateCommand não têm efeito. O comando só pode ser executado no diretório de trabalho padrão do container, usando o usuário padrão do container. Para mais informações, consulte Run commands in containers.

  • Com esta propriedade definida, somente scripts shell podem ser executados em containers Linux. Não é possível definir um interpretador de script adicionando um comando no formato #!/usr/bin/python no início do script. Para mais informações, consulte Run commands in containers.

ContainerId

String

No

No

O id do container.

Apenas strings hexadecimais de 64 bits são suportadas. IDs de container com os prefixos docker://, containerd:// ou cri-o:// podem ser usados para especificar runtimes de container.

Observe os seguintes pontos ao especificar esta propriedade:

  • Com esta propriedade definida, o Cloud Assistant executa scripts no container indicado na instância.

  • Com esta propriedade definida, os scripts só podem ser executados em instâncias Linux com o Cloud Assistant Agent instalado. A versão do Cloud Assistant Agent deve ser 2.2.3.344 ou posterior.

  • Com esta propriedade definida, Username informado na solicitação desta operação e WorkingDir informado na solicitação da operação CreateCommand não têm efeito. O comando só pode ser executado no diretório de trabalho padrão do container, usando o usuário padrão do container. Para mais informações, consulte Run commands in containers.

  • Com esta propriedade definida, somente scripts shell podem ser executados em containers Linux. Não é possível definir um interpretador de script adicionando um comando no formato #!/usr/bin/python no início do script. Para mais informações, consulte Run commands in containers.

Username

String

No

No

O nome de usuário utilizado para executar o comando nas instâncias.

O nome de usuário pode ter no máximo 255 caracteres.

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

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

Também é possível especificar outros nomes de usuário já existentes nas instâncias para executar o comando. Por questões de segurança, recomenda-se executar os comandos do Cloud Assistant como um usuário comum. Para mais informações, consulte Run Cloud Assistant commands as a regular user.

Tags

List

No

No

As tags.

Especifique até 20 tags no seguinte formato: [{"Key":"tagKey","Value":"tagValue"},{"Key":"tagKey2","Value":"tagValue2"}].

Para mais informações, consulte Tags properties.

Sintaxe de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propriedades de Tags

Property

Type

Required

Editable

Description

Constraint

Key

String

Yes

No

A chave da tag.

A chave da tag deve ter entre 1 e 128 caracteres e não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

Value

String

No

No

O valor da tag.

O valor da tag pode ter no máximo 128 caracteres e não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

Valores de retorno

Fn::GetAtt

  • InvokeId: o id de invocação do comando.

  • InvokeInstances: as instâncias nas quais o comando foi executado.

  • InvokeResults: os resultados da execução do comando.

Nota

Para executar o comando apenas uma vez, consulte ALIYUN::ECS::RunCommand.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CommandId:
    Type: String
    Description: The id of command.
  InstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
Resources:
  Invocation:
    Type: ALIYUN::ECS::Invocation
    Properties:
      CommandId:
        Ref: CommandId
      InstanceIds:
        - Ref: InstanceId
Outputs:
  InvokeId:
    Description: The id of command execution.
    Value:
      Fn::GetAtt:
        - Invocation
        - InvokeId                   
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CommandId": {
      "Type": "String",
      "Description": "The id of command."
    },
    "InstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
    }
  },
  "Resources": {
    "Invocation": {
      "Type": "ALIYUN::ECS::Invocation",
      "Properties": {
        "CommandId": {
          "Ref": "CommandId"
        },
        "InstanceIds": [
          {
            "Ref": "InstanceId"
          }
        ]
      }
    }
  },
  "Outputs": {
    "InvokeId": {
      "Description": "The id of command execution.",
      "Value": {
        "Fn::GetAtt": [
          "Invocation",
          "InvokeId"
        ]
      }
    }
  }
}