DescribeCommandInvocations - Simple Application Server: Central de Documentação do Alibaba Cloud

Consulta as execuções e o status de execução de um comando do Cloud Assistant.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

swas-open:DescribeCommandInvocations

get

*All Resource

*

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 a operação ListRegions para consultar a lista de regiões mais recente.	cn-hangzhou
InstanceId	string	Não	O ID do servidor de aplicativo simples.	ace0706b2ac4454d984295a94213****
CommandId	string	Não	O ID do comando. Você pode chamar a operação DescribeCommands para consultar todos os IDs de comando disponíveis.	c-sh02yh0932w****
InvokeId	string	Não	O ID de execução do comando.	t-hz02p9545t6****
CommandName	string	Não	O nome do comando. Se CommandName e InstanceId forem especificados, CommandName não terá efeito.	testName
InvocationStatus	string	Não	O estado geral de execução do comando. O valor deste parâmetro depende do status de execução do comando em todas as instâncias envolvidas. Valores válidos: Pending: O comando está sendo verificado ou enviado. Quando o estado de execução em pelo menos uma instância é Pending, o estado geral de execução é Pending. Running: O comando está sendo executado nas instâncias. Quando o estado de execução em pelo menos uma instância é Running, o estado geral de execução é Running. Success: Quando o estado de execução em pelo menos uma instância é Success e o estado de execução nas outras instâncias é Stopped ou Success, o estado geral de execução é Success. Comando configurado para execução imediata: A execução do comando foi concluída e o código de saída é 0. Failed: Quando o estado de execução em todas as instâncias é Stopped ou Failed, o estado geral de execução é Failed. Quando o estado de execução em uma instância é um dos seguintes valores, Failed é retornado como o estado geral de execução: Invalid: O comando é inválido. Aborted: Falha ao enviar o comando. Failed: A execução do comando foi concluída e o código de saída não é 0. Timeout: A execução do comando expirou. Error: Ocorreu um erro durante a execução do comando. Stopping: A tarefa do comando está sendo interrompida. Quando o estado de execução em pelo menos uma instância é Stopping, o estado geral de execução é Stopping. Stopped: A tarefa do comando foi interrompida. Quando o estado de execução em todas as instâncias é Stopped, o estado geral de execução é Stopped. Quando o estado de execução em uma instância é um dos seguintes valores, Stopped é retornado como o estado geral de execução: Cancelled: A tarefa do comando foi cancelada. Terminated: A tarefa do comando foi encerrada. PartialFailed: A execução do comando é bem-sucedida em algumas instâncias e falha em outras. Quando o estado de execução em algumas instâncias é Success e o estado de execução em outras instâncias é Failed ou Stopped, o estado geral de execução é PartialFailed. Nota O valor do parâmetro de resposta InvokeStatus é semelhante ao valor de InvocationStatus. Recomendamos que você ignore InvokeStatus e verifique o valor de InvocationStatus.	Success
CommandType	string	Não	O tipo de comando. Valores válidos: RunBatScript: comando em lote, aplicável a instâncias Windows RunPowerShellScript: comando PowerShell, aplicável a instâncias Windows RunShellScript: comando shell, aplicável a instâncias Linux	RunPowerShellScript
PageNumber	string	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página. Valor máximo: 50. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	30637AD6-D977-4833-A54C-CC89483E****
TotalCount	integer	O número total de entradas.	10
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
CommandInvocations	array<object>	As execuções do comando.
	array<object>
InvokeId	string	O ID de execução do comando.	t-hz0373jyzxt****
CreationTime	string	A hora em que o comando foi criado.	2023-04-27T10:11:58
CommandId	string	O ID do comando.	c-hy0338xh28r****
InvocationStatus	string	O estado geral de execução do comando. Valores válidos: Pending: O comando está sendo verificado ou enviado. Invalid: O tipo de comando ou parâmetro especificado é inválido. Aborted: Falha ao enviar o comando para as instâncias. Para enviar um comando para uma instância, certifique-se de que a instância esteja no estado Running e que o comando seja enviado para a instância dentro de 1 minuto. Running: O comando está sendo executado nas instâncias. Success: A execução do comando foi concluída e o código de saída é 0. Failed: A execução do comando foi concluída e o código de saída não é 0. Error: A execução do comando não pode prosseguir devido a uma exceção. Timeout: A execução do comando expirou. Cancelled: A execução do comando foi cancelada e o comando não foi iniciado. Stopping: O comando no estado Running está sendo interrompido. Terminated: O comando foi encerrado durante a execução.	Success
CommandName	string	O nome do comando.	testCommandName
CommandType	string	O tipo de comando.	RunShellScript
CommandDescription	string	A descrição do comando.	testDescription
Username	string	O nome de usuário usado para executar o comando.	root
WorkingDir	string	O diretório de trabalho do comando.	c:\wwwroot
Timeout	integer	O período de tempo limite. Unidade: segundos.	60
CommandContent	string	O conteúdo do comando.	echo 123
Parameters	string	Os parâmetros personalizados no comando. Se não existir nenhum parâmetro personalizado no comando, o valor padrão é {}.	{}
InvokeInstances	array<object>	As instâncias nas quais o comando é executado.
	object
InstanceId	string	The ID of the simple application server.	2445f4aecdac4b71ba2c7e3a7ccf****
StartTime	string	The beginning of the time range during which the command is run on the instance.	2023-05-09T03:32:24Z
FinishTime	string	The end of the time range during which the command is run on the instance.	2023-04-03T02:42:29Z
InvocationStatus	string	The execution state of the command on a single instance. Valid values: Pending: The command is being verified or sent. Invalid: The specified command type or parameter is invalid. Aborted: The command failed to be sent to the instance. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute. Running: The command is being run on the instance. Success: Command that is set to run only once: The command execution is complete, and the exit code is 0. Command that is set to run on a schedule: The previous command execution is complete, the exit code is 0, and the specified cycle ends. Failed: Command that is set to run only once: The command execution is complete, and the exit code is not 0. Command that is set to run on a schedule: The previous command execution is complete, the exit code is not 0, and the specified cycle is about to end. Error: The command execution cannot proceed due to an exception. Timeout: The command execution timed out. Cancelled: The command execution is canceled, and the command is not started. Stopping: The command task is being stopped. Terminated: The command is terminated when it is being run.	Running
Output	string	The command output.	OutputMsg
ExitCode	integer	The exit code of the command. For Linux instances, the exit code is the exit code of the shell command. For Windows instances, the exit code is the exit code of the batch or PowerShell command.	0
ErrorInfo	string	The error message returned if the command failed to be sent or run. Valid values: null: The command is run as expected. the specified instance does not exists: The specified instance does not exist or is released. the instance has released when create task: The instance is released when the command is being run. the instance is not running when create task: The instance is not in the Running state when the command is being run. the command is not applicable: The command is not applicable to the specified instance. the specified account does not exists: The specified account does not exist. the specified directory does not exists: The specified directory does not exist. the cron job expression is invalid: The specified CRON expression for the execution schedule is invalid. the aliyun service is not running on the instance: Cloud Assistant Agent is not running. the aliyun service in the instance does not response: Cloud Assistant Agent does not respond to your request. the aliyun service in the instance is upgrading now: Cloud Assistant Agent is being updated. the aliyun service in the instance need upgrade: Cloud Assistant Agent needs to be updated. the command delivery has been timeout: The request to send the command timed out. the command execution has been timeout: The command execution timed out. the command execution got an exception: An exception occurred when the command was being run. the command execution has been interrupted: The command execution is interrupted. the command execution exit code is not zero: The command execution is complete, and the exit code is not 0.	the specified instance does not exists
ErrorCode	string	The error code returned if the command failed to be sent or run. null: The command is run as expected. InstanceNotExists: The specified instance does not exist or is released. InstanceReleased: The instance is released when the command is being run. InstanceNotRunning: The instance is not in the Running state when the command is being run. CommandNotApplicable: The command is not applicable to the specified instance. AccountNotExists: The specified account does not exist. DirectoryNotExists: The specified directory does not exist. BadCronExpression: The specified CRON expression for the execution schedule is invalid. ClientNotRunning: Cloud Assistant Agent is not running. ClientNotResponse: Cloud Assistant Agent does not respond to your request. ClientIsUpgrading: Cloud Assistant Agent is being updated. ClientNeedUpgrade: Cloud Assistant Agent needs to be updated. DeliveryTimeout: The request to send the command timed out. ExecutionTimeout: The command execution timed out. ExecutionException: An exception occurred when the command was being run. ExecutionInterrupted: The command execution is interrupted. ExitCodeNonzero: The command execution is complete, and the exit code is not 0.	InstanceNotExists

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "CommandInvocations": [
    {
      "InvokeId": "t-hz0373jyzxt****",
      "CreationTime": "2023-04-27T10:11:58",
      "CommandId": "c-hy0338xh28r****",
      "InvocationStatus": "Success",
      "CommandName": "testCommandName",
      "CommandType": "RunShellScript",
      "CommandDescription": "testDescription",
      "Username": "root",
      "WorkingDir": "c:\\wwwroot",
      "Timeout": 60,
      "CommandContent": "echo 123",
      "Parameters": "{}",
      "InvokeInstances": [
        {
          "InstanceId": "2445f4aecdac4b71ba2c7e3a7ccf****",
          "StartTime": "2023-05-09T03:32:24Z",
          "FinishTime": "2023-04-03T02:42:29Z",
          "InvocationStatus": "Running",
          "Output": "OutputMsg",
          "ExitCode": 0,
          "ErrorInfo": "the specified instance does not exists",
          "ErrorCode": "InstanceNotExists"
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.