Aciona um comando do Cloud Assistant em uma ou mais instâncias ECS especificando parâmetros como CommandId, InstanceId e ResourceGroupId.
Descrição da operação
Descrição da operação
-
As seguintes limitações se aplicam às instâncias ECS de destino. Se você selecionar várias instâncias ECS e uma delas não atender às condições de execução, será necessário chamar a operação novamente.
-
A instância de destino deve estar no estado Running. Você pode chamar DescribeInstances para consultar o status da instância de destino.
-
O Agente do Cloud Assistant deve ser instalado na instância de destino com antecedência.
-
Para executar um comando do PowerShell, a instância de destino deve ter o módulo do PowerShell configurado.
-
-
Execução única: O comando é executado apenas uma vez.
-
Execução agendada:
O comando é executado na frequência especificada pelo parâmetro Frequency. O resultado da execução anterior não afeta a próxima execução.
Se você especificar um fuso horário ao executar uma tarefa agendada com base em uma expressão Cron, o horário de execução agendada será baseado no fuso horário especificado. Se você não especificar um fuso horário, o horário de execução agendada será baseado no fuso horário do sistema da instância ECS. Certifique-se de que a hora ou o fuso horário da instância ECS seja consistente com a hora esperada. Para obter mais informações sobre fusos horários, consulte Gerenciar serviços de sincronização de hora.
A versão do Agente do Cloud Assistant deve ser pelo menos as seguintes versões para suportar os novos recursos de tarefas agendadas (execução em intervalos fixos, execução única em um horário especificado e especificação de um ano ou fuso horário para execução agendada baseada em expressão Cron). Se o código de erro ClientNeedUpgrade for retornado, consulte Atualizar ou desativar atualizações do Agente do Cloud Assistant para atualizar o agente para a versão mais recente.
Linux: 2.2.3.282
Windows: 2.1.3.282
-
Um comando pode falhar ao ser executado devido a status anormal da instância, exceções de rede ou exceções do Agente do Cloud Assistant. Nenhuma informação de execução é gerada quando um comando falha ao ser executado. Para obter mais informações, consulte Erros comuns e soluções para falhas de execução.
-
Se você ativou o recurso de parâmetros personalizados ao criar o comando, deverá passar parâmetros personalizados (
Parameters) ao executar o comando. -
Chame DescribeCloudAssistantStatus para consultar o status do Cloud Assistant da instância de destino primeiro. Execute o comando apenas quando CloudAssistantStatus for true, especialmente para instâncias recém-adquiridas.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
ecs:InvokeCommand |
update |
*Command.
*Instância.
|
|
Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| RegionId |
string |
Sim |
O ID da região. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente. |
cn-hangzhou |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos para a execução do comando. Ao especificar este parâmetro:
|
rg-bp67acfmxazb4p**** |
| CommandId |
string |
Sim |
O ID do comando. Você pode chamar DescribeCommands para consultar todos os IDs de comando disponíveis. Nota
Você pode executar comandos públicos especificando o nome do comando. Para obter mais informações, consulte Visualizar e executar comandos públicos do Cloud Assistant. |
c-e996287206324975b5fbe1d**** |
| RepeatMode |
string |
Não |
Especifica como o comando é executado. Valores válidos:
Valor padrão:
Precauções:
|
Once |
| Timed |
boolean |
Não |
Nota
Este parâmetro foi descontinuado e não tem efeito se especificado. |
true |
| Frequency |
string |
Não |
A programação na qual o comando é executado. Três tipos de execução agendada são suportados: intervalo fixo (com base em uma expressão Rate), execução única em um horário especificado e agendamento baseado em relógio (com base em uma expressão Cron).
|
0 */20 * * * ? |
| Parameters |
object |
Não |
Os pares chave-valor de parâmetros personalizados a serem passados quando o recurso de parâmetros personalizados está ativado. O número de parâmetros personalizados varia de 0 a 10.
Você pode desdefinir este parâmetro para desativar os parâmetros personalizados. |
{"name":"Jack", "accessKey":"LTAI************"} |
| Username |
string |
Não |
O nome de usuário usado para executar o comando na instância ECS. O valor pode ter até 255 caracteres de comprimento.
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 obter mais informações, consulte Configurar um usuário comum para executar comandos do Cloud Assistant. |
test |
| WindowsPasswordName |
string |
Não |
O nome da senha usada pelo usuário para executar o comando em uma instância Windows. O valor pode ter até 255 caracteres de comprimento. Se você quiser executar um comando como um usuário não padrão (System) em uma instância Windows, deverá especificar tanto Nota
Este parâmetro não é necessário quando você executa um comando como o usuário root em uma instância Linux ou o usuário System em uma instância Windows. |
axtSecretPassword |
| InstanceId |
array |
Não |
A lista de instâncias nas quais executar o comando. Você pode especificar até 100 IDs de instância. Valores válidos de N: 1 a 100. Você também pode solicitar um aumento de cota no Quota Center (nome da cota: Número máximo de instâncias suportadas para execução de comando). |
i-bp185dy2o3o6n**** |
|
string |
Não |
O ID da instância na qual executar o comando. |
i-bp185dy2o3o6n**** |
|
| ContainerId |
string |
Não |
O ID do contêiner. Apenas strings hexadecimais de 64 bits são suportadas. Você pode usar o prefixo Precauções:
|
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
Não |
O nome do contêiner. Precauções:
|
test-container |
| Timeout |
integer |
Não |
O período de tempo limite para a execução do comando. Unidade: segundos.
|
60 |
| Tag |
array<object> |
Não |
As tags. |
|
|
object |
Não |
As tags. |
||
| Key |
string |
Não |
A chave da tag para a execução do comando. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. Se você usar uma única tag para filtrar recursos, o número de recursos com esta tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, o número de recursos com todas as tags especificadas anexadas não pode exceder 1.000. Se o número de recursos exceder 1.000, execute a operação ListTagResources para consultar os recursos. A chave da tag pode ter até 64 caracteres de comprimento e não pode começar com |
TestKey |
| Value |
string |
Não |
O valor da tag para a execução do 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 de comprimento e não pode conter |
TestValue |
| ClientToken |
string |
Não |
O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas certifique-se de que o token seja exclusivo entre diferentes solicitações. O valor do ClientToken pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para obter mais informações, consulte Como garantir a idempotência. |
123e4567-e89b-12d3-a456-42665544**** |
| ResourceTag |
array<object> |
Não |
As tags usadas para filtrar instâncias. Você pode usar tags para executar comandos em lote em instâncias com a mesma tag sem especificar InstanceId. |
|
|
object |
Não |
A tag usada para filtrar instâncias. Você pode usar tags para executar comandos em lote em instâncias com a mesma tag sem especificar InstanceId. |
||
| Key |
string |
Não |
A chave da tag usada para filtrar instâncias. Precauções:
|
TestKey |
| Value |
string |
Não |
O valor da tag usado para filtrar instâncias. Precauções:
|
TestValue |
| TerminationMode |
string |
Não |
O modo no qual a tarefa é interrompida (interrompida manualmente ou interrompida devido a tempo limite). Valores válidos:
|
ProcessTree |
| Launcher |
string |
Não |
O programa de inicialização para a execução do script. O valor não pode exceder 1 KB de comprimento. |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| WorkingDir |
string |
Não |
O diretório no qual o comando é executado na instância ECS. O valor pode ter até 200 caracteres de comprimento.
|
/home/user |
| OssOutputDelivery |
string |
Não |
A configuração de entrega do OSS para a saída da execução do comando.
|
oss://testBucket/testPrefix |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| InvokeId |
string |
O ID de execução do comando. |
t-7d2a745b412b4601b2d47f6a768d**** |
| RequestId |
string |
O ID da solicitação. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Exemplos
Resposta de sucesso
JSON formato
{
"InvokeId": "t-7d2a745b412b4601b2d47f6a768d****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 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. | A operação de API não é suportada na região especificada. Verifique se o valor do parâmetro RegionId está correto. |
| 400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | O parâmetro WorkingDir especificado é inválido. |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | O ID da instância está vazio. |
| 400 | InvalidContainerId.Malformed | The specified parameter ContainerId is not valid. | O ID do contêiner especificado é inválido. |
| 400 | InvalidContainerName.Malformed | The specified parameter ContainerName is not valid. | O nome do contêiner especificado é inválido. |
| 400 | InvalidClientToken.Malformed | The specified parameter clientToken is not valid. | O parâmetro idempotente especificado é inválido. |
| 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. | O parâmetro Parameters especificado é inválido. |
| 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. | O bucket do OSS especificado no parâmetro OssOutputDelivery está em uma região diferente. |
| 400 | InvalidParameter.OssOutputDelivery | The specified parameter OssOutputDelivery is not valid. | O parâmetro OssOutputDelivery especificado é inválido. |
| 400 | InvalidOssOutputDelivery.KeyPrefixMalformed | The prefix of the OSS key specified in the parameter OssOutputDelivery is not valid. | O prefixo especificado no parâmetro OssOutputDelivery é inválido. |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | Ocorreu um erro ao enviar a solicitação. Tente novamente mais tarde. |
| 403 | InvalidParameterCharacter | The specified parameter %s contains illegal characters. | |
| 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. | O número de instâncias de destino excede o limite superior. |
| 403 | Invocation.ExceedQuota | The invocation quota in the current region has been reached for today. | O número de execuções de comando na região atual atingiu a cota diária. |
| 403 | ParameterCount.ExceedLimit | The maximum number of parameters is exceeded. | O número de parâmetros excede o máximo permitido. |
| 403 | ParameterKey.ExceedLimit | The maximum length of a parameter name is exceeded. | O comprimento da chave do parâmetro especificado excede o comprimento máximo permitido. |
| 403 | CmdContent.ExceedLimit | The maximum length of a command is exceeded. | O conteúdo do seu comando é muito longo. Simplifique o conteúdo do seu comando. |
| 403 | ParameterKey.Duplicate | Parameter names cannot be duplicated. | Os nomes dos parâmetros não podem ser duplicados. Verifique os nomes e tente novamente. |
| 403 | Parameter.NotMatched | The passed-in parameters do not match the parameters defined when you created the command. | Os parâmetros personalizados transmitidos não correspondem aos parâmetros personalizados definidos quando o comando foi criado. |
| 403 | ParameterType.NotSupported | The type of parameter value is not supported. | |
| 403 | Username.ExceedLimit | The length of the username exceeds the upper limit. | O comprimento do nome de usuário excede o limite superior. |
| 403 | WindowsPasswordName.ExceedLimit | The length of the WindowsPasswordName exceeds the upper limit. | O comprimento do parâmetro WindowsPasswordName especificado excede o limite superior. |
| 403 | WindowsPasswordName.Missed | WindowsPasswordName must be specified when you create a Windows task. | O valor do parâmetro de solicitação CommandType (WindowsPasswordName) não foi fornecido. |
| 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. | O parâmetro especificado por {{oos:?}} no conteúdo do comando não foi encontrado. |
| 403 | ParameterStore.NoPermission | You have no access to Parameter Store. | |
| 403 | Operation.Forbidden | The operation is not permitted. | A operação não é permitida. |
| 403 | IdempotentParameterMismatch | The specified parameter has changed while using an already used clientToken. | Os parâmetros da solicitação não correspondem à solicitação com o mesmo ClientToken. |
| 403 | IdempotentProcessing | The previous idempotent request(s) is still processing. | A solicitação idempotente anterior ainda está sendo processada. Tente novamente mais tarde. |
| 403 | InvalidLauncher.LengthLimitExceeded | The length of the parameter Launcher exceeds the limit of 1 KB characters. | O comprimento do parâmetro Launcher excede o limite de 1 KB. |
| 403 | InvalidParameterCharset.Parameters | The parameter Parameters contains illegal charset. | O parâmetro de comando contém caracteres inválidos. |
| 403 | CreateServiceLinkedRole.NoPermission | You do not have permission to create ServiceLinkedRole for output delivery. | Você não tem permissão para criar funções vinculadas ao serviço. |
| 403 | InvalidTimeout.ExceedLimit | The specified parameter Timeout exceeds the upper limit. | |
| 404 | InvalidRepeatMode.NotFound | The specified repeat mode does not exist. | O modo de execução de comando especificado não existe. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | O RegionId especificado não existe. Verifique se o produto está disponível nesta região. |
| 404 | InvalidInstance.NotFound | The specified instance does not exist. | A instância especificada não existe. |
| 404 | InvalidCmdId.NotFound | The specified command ID does not exist. | O parâmetro CommandId especificado é inválido. Verifique se o valor do parâmetro está correto. Você pode chamar DescribeCommands para consultar todos os valores de CommandId disponíveis. |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | O grupo de recursos não foi encontrado nos registros. |
| 404 | InvalidTerminationMode.NotFound | The specified parameter TerminationMode does not exist. | O parâmetro TerminationMode especificado não existe. |
| 404 | InvalidOssOutputDelivery.BucketNotFound | The OSS bucket specified in the parameter OssOutputDelivery does not exist. | O bucket especificado no parâmetro OssOutputDelivery não existe. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.