Especifica parâmetros como CommandId, InstanceId e ResourceGroupId para acionar um comando do Cloud Assistant em uma ou mais instâncias ECS.
Descrição da operação
Guia da API
-
As seguintes restrições se aplicam às instâncias ECS de destino. Se você selecionar várias instâncias ECS e qualquer uma delas não atender às condições de execução, será necessário invocar a API novamente.
-
O status da instância deve ser em execução (
Running). Você pode chamar DescribeInstances para consultar o status da instância. -
O Cloud Assistant Agent já deve estar instalado.
-
Ao executar um comando do tipo PowerShell, a instância deve ter o módulo PowerShell configurado.
-
-
Execução única: O comando é executado apenas uma vez.
-
Execução agendada:
-
O comando é executado periodicamente com base na frequência de tempo especificada pelo parâmetro
Frequency. O resultado da execução anterior não afeta a próxima execução. -
Quando você executa uma tarefa agendada com base em uma expressão cron e especifica um fuso horário, o horário de execução agendada é baseado no fuso horário especificado. Se você não especificar um fuso horário, o horário de execução agendada é baseado no fuso horário do sistema da instância ECS, e o horário de execução segue o horário do sistema da instância. Certifique-se de que o horário ou fuso horário da instância ECS corresponda ao horário esperado. Para mais informações sobre fusos horários, consulte Gerenciar serviço de sincronização de horário.
Para suportar novos recursos de tarefas agendadas (execução em intervalos fixos, execução única em um horário especificado ou especificação de ano ou fuso horário ao executar com base em uma expressão cron), a versão do Cloud Assistant Agent deve ser pelo menos a seguinte:
-
Linux: 2.2.3.282
-
Windows: 2.1.3.282
Se a resposta retornar o código de erro
ClientNeedUpgrade, consulte Atualizar ou desabilitar atualização do Cloud Assistant Agent para atualizar o cliente para a versão mais recente. -
-
Um comando pode falhar na execução devido a um status anormal da instância, problemas de rede ou um Cloud Assistant Agent anormal. Nesses casos, nenhuma informação de execução é gerada. Para mais informações, consulte Falhas comuns de execução e sugestões de solução de problemas.
-
Se você habilitar o recurso de Parâmetro Personalizado ao criar um comando, deverá passar os parâmetros personalizados (
Parameters) ao executar o comando. -
Recomendamos que você primeiro chame DescribeCloudAssistantStatus para verificar o status do Cloud Assistant da instância e execute o comando somente quando
CloudAssistantStatusfor 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
*Instance
|
|
Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| RegionId |
string |
Sim |
O ID da região do comando. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente. |
cn-hangzhou |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos ao qual atribuir as execuções do comando. Ao definir este parâmetro, observe os seguintes itens:
|
rg-bp67acfmxazb4p**** |
| CommandId |
string |
Sim |
O ID da região do comando. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente. |
c-e996287206324975b5fbe1d**** |
| RepeatMode |
string |
Não |
O ID do comando. Você pode chamar a operação DescribeCommands para consultar todos os IDs de comandos disponíveis. Nota
Comandos comuns do Cloud Assistant podem ser executados com base em seus nomes. Para mais informações, consulte Visualizar e executar comandos comuns do Cloud Assistant. |
Once |
| Timed |
boolean |
Não |
Especifica como executar o comando. Valores válidos:
Valor padrão:
Observe os seguintes itens ao especificar esta propriedade:
|
true |
| Frequency |
string |
Não |
Nota
Este parâmetro não é mais utilizado e não tem efeito. |
0 */20 * * * ? |
| Parameters |
object |
Não |
O agendamento para execução do comando. Você pode configurar um comando para ser executado em um intervalo fixo com base em uma expressão rate, executado apenas uma vez em um horário específico ou executado em horários específicos com base em uma expressão cron.
|
{"name":"Jack", "accessKey":"LTAI************"} |
| Username |
string |
Não |
Os pares chave-valor dos parâmetros personalizados a serem passados quando o recurso de parâmetro personalizado está habilitado. Você pode especificar até 10 parâmetros personalizados.
Se você deseja desabilitar o recurso de parâmetro personalizado, pode deixar este parâmetro vazio. |
test |
| WindowsPasswordName |
string |
Não |
O nome de usuário a ser usado para executar o comando nas instâncias ECS. O nome de usuário não pode exceder 255 caracteres de comprimento.
Você também pode especificar outros nomes de usuário que já existam nas instâncias para executar o comando. Por motivos de segurança, recomendamos que você execute comandos do Cloud Assistant como um usuário regular. Para mais informações, consulte Executar comandos do Cloud Assistant como um usuário regular. |
axtSecretPassword |
| InstanceId |
array |
Não |
O nome da senha a ser usada para executar o comando em uma instância Windows. O nome não pode exceder 255 caracteres de comprimento. Se você não deseja usar o usuário System padrão para executar o comando em instâncias Windows, especifique tanto WindowsPasswordName quanto Nota
Se você usar o nome de usuário root para instâncias Linux ou o nome de usuário System para instâncias Windows para executar o comando, não será necessário especificar WindowsPasswordName. |
i-bp185dy2o3o6n**** |
|
string |
Não |
The ID of instance N on which you want to run the command. |
i-bp185dy2o3o6n**** |
|
| ContainerId |
string |
Não |
Os IDs das instâncias nas quais você deseja executar o comando. Você pode especificar até 100 IDs de instâncias em cada solicitação. Valores válidos de N: 1 a 100. Você pode solicitar um aumento de cota no console do Quota Center. O nome da cota é Número máximo de instâncias suportadas para execução de comandos. |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
Não |
O ID do contêiner. Apenas strings hexadecimais de 64 bits são suportadas. Você pode usar IDs de contêiner prefixados com Observe os seguintes itens:
|
test-container |
| Timeout |
integer |
Não |
O nome do contêiner. Observe os seguintes itens:
|
60 |
| Tag |
array<object> |
Não |
O período de timeout para a execução do comando. Unidade: segundos.
|
|
|
object |
Não |
The tags of the command. |
||
| Value |
string |
Não |
The value of tag N to add to the command task. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain |
TestValue |
| Key |
string |
Não |
The key of tag N to add to the command task. Valid values of N: 1 to 20. The tag key cannot be an empty string. If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation. The tag key can be up to 64 characters in length and cannot start with |
TestKey |
| ClientToken |
string |
Não |
As tags do comando. |
123e4567-e89b-12d3-a456-42665544**** |
| ResourceTag |
array<object> |
Não |
O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para mais informações, consulte Como garantir a idempotência. |
|
|
object |
Não |
Tag N of the instance. If you do not specify InstanceId.N, the command is run on the instances that have the specified tags. |
||
| Value |
string |
Não |
The value of tag N of the instance. Take note of the following items:
|
TestValue |
| Key |
string |
Não |
The key of tag N of the instance. Take note of the following items:
|
TestKey |
| TerminationMode |
string |
Não |
As tags da instância. Se você não especificar InstanceId.N, o comando será executado nas instâncias que possuem as tags especificadas. |
ProcessTree |
| Launcher |
string |
Não |
Especifica como interromper a tarefa de comando quando uma execução de comando é interrompida manualmente ou atinge o timeout. Valores válidos:
|
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| WorkingDir |
string |
Não |
O launcher para execução de scripts. O valor não pode exceder 1 KB de comprimento. |
/home/user |
| OssOutputDelivery |
string |
Não |
O caminho de execução do comando nas instâncias ECS. O valor pode ter até 200 caracteres de comprimento.
|
oss://testBucket/testPrefix |
|
Não |
A configuração de entrega OSS para a saída do comando.
|
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| InvokeId |
string |
O ID da tarefa de 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. | |
| 400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | |
| 400 | InvalidContainerId.Malformed | The specified parameter ContainerId is not valid. | |
| 400 | InvalidContainerName.Malformed | The specified parameter ContainerName is not valid. | |
| 400 | InvalidClientToken.Malformed | The specified parameter clientToken is not valid. | |
| 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. | |
| 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. | |
| 400 | InvalidParameter.OssOutputDelivery | The specified parameter OssOutputDelivery is not valid. | |
| 400 | InvalidOssOutputDelivery.KeyPrefixMalformed | The prefix of the OSS key specified in the parameter OssOutputDelivery is not valid. | |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | |
| 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. | |
| 403 | Invocation.ExceedQuota | The invocation quota in the current region has been reached for today. | |
| 403 | ParameterCount.ExceedLimit | The maximum number of parameters is exceeded. | |
| 403 | ParameterKey.ExceedLimit | The maximum length of a parameter name is exceeded. | |
| 403 | CmdContent.ExceedLimit | The maximum length of a command is exceeded. | |
| 403 | ParameterKey.Duplicate | Parameter names cannot be duplicated. | |
| 403 | Parameter.NotMatched | The passed-in parameters do not match the parameters defined when you created the command. | |
| 403 | ParameterType.NotSupported | The type of parameter value is not supported. | |
| 403 | Username.ExceedLimit | The length of the username exceeds the upper limit. | |
| 403 | WindowsPasswordName.ExceedLimit | The length of the WindowsPasswordName exceeds the upper limit. | |
| 403 | WindowsPasswordName.Missed | WindowsPasswordName must be specified when you create a Windows task. | |
| 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. | |
| 403 | ParameterStore.NoPermission | You have no access to Parameter Store. | |
| 403 | Operation.Forbidden | The operation is not permitted. | |
| 403 | IdempotentParameterMismatch | The specified parameter has changed while using an already used clientToken. | |
| 403 | IdempotentProcessing | The previous idempotent request(s) is still processing. | |
| 403 | InvalidLauncher.LengthLimitExceeded | The length of the parameter Launcher exceeds the limit of 1 KB characters. | |
| 403 | InvalidParameterCharset.Parameters | The parameter Parameters contains illegal charset. | |
| 403 | CreateServiceLinkedRole.NoPermission | You do not have permission to create ServiceLinkedRole for output delivery. | |
| 403 | InvalidTimeout.ExceedLimit | The specified parameter Timeout exceeds the upper limit. | |
| 404 | InvalidRepeatMode.NotFound | The specified repeat mode does not exist. | |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | |
| 404 | InvalidInstance.NotFound | The specified instance does not exist. | |
| 404 | InvalidCmdId.NotFound | The specified command ID does not exist. | |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | |
| 404 | InvalidTerminationMode.NotFound | The specified parameter TerminationMode does not exist. | |
| 404 | InvalidOssOutputDelivery.BucketNotFound | The OSS bucket specified in the parameter OssOutputDelivery does not exist. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.