Todos os produtos
Search

Este produto

    Simple Application Server:DescribeCommandInvocations

    Central de documentação

    Simple Application Server:DescribeCommandInvocations

    Última atualização: Sep 08, 2026

    Consulta a lista e o status dos comandos executados pelo 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

    *Todos os recursos.

    *

    		 Nenhuma 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 ListRegions para consultar as regiões disponíveis.

    cn-hangzhou
    InstanceId

    string

    Não

    O ID da instância do servidor de aplicação simples.

    ace0706b2ac4454d984295a94213****
    CommandId

    string

    Não

    O ID do comando. Você pode chamar 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 o parâmetro InstanceId também for especificado, este parâmetro não terá efeito.

    testName
    InvocationStatus

    string

    Não

    O status geral de execução do comando. O status geral de execução depende do status de execução comum em todas as instâncias nesta invocação. Valores válidos:

    • Pending: O sistema está validando ou enviando o comando. Se o status de execução do comando em pelo menos uma instância for Pending, o status geral de execução será Pending.

    • Running: O comando está em execução nas instâncias. Se o status de execução do comando em pelo menos uma instância for Running, o status geral de execução será Running.

    • Success: O status de execução do comando em cada instância é Stopped ou Success, e o status de execução do comando em pelo menos uma instância é Success. Nesse caso, o status geral de execução é Success.

      • Tarefa única: A execução do comando foi concluída e o código de saída é 0.

    • Failed: O status de execução do comando em cada instância é Stopped ou Failed. Nesse caso, o status geral de execução é Failed. O status geral de execução é Failed quando o status de execução do comando em uma instância é um ou mais dos seguintes valores:

      • Falha na validação do comando (Invalid).

      • Falha no envio do comando (Aborted).

      • A execução do comando foi concluída, mas o código de saída não é 0 (Failed).

      • A execução do comando expirou (Timeout).

      • A execução do comando encontrou uma exceção (Error).

    • Stopping: A tarefa está sendo interrompida. Se o status de execução do comando em pelo menos uma instância for Stopping, o status geral de execução será Stopping.

    • Stopped: A tarefa foi interrompida. Se o status de execução do comando em todas as instâncias for Stopped, o status geral de execução será Stopped. O status geral de execução é Stopped quando o status de execução do comando em uma instância é um dos seguintes valores:

      • Tarefa cancelada (Cancelled).

      • Tarefa encerrada (Terminated).

    • PartialFailed: A execução do comando foi bem-sucedida em algumas instâncias e falhou em outras. Se o status de execução do comando em cada instância for Success, Failed ou Stopped, o status geral de execução será PartialFailed.

    Nota

    O parâmetro de resposta InvokeStatus tem um significado semelhante, mas recomendamos que você verifique o valor deste parâmetro.

    Success
    CommandType

    string

    Não

    O tipo de comando. Valores válidos:

    • RunBatScript: Comando Bat para instâncias Windows.

    • RunPowerShellScript: Comando PowerShell para instâncias Windows.

    • RunShellScript: Comando Shell para instâncias Linux.

    RunPowerShellScript
    PageNumber

    string

    Não

    O número da página. Valor mínimo: 1. Valor padrão: 1.

    1
    PageSize

    string

    Não

    O número de entradas por página para uma consulta paginada.

    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 do resultado da consulta.

    1
    PageSize

    integer

    A configuração do número de entradas por página para uma consulta paginada. Este é o tamanho da paginação.

    10
    CommandInvocations

    array<object>

    A lista de execuções de comando.

    array<object>

    A estrutura de informações de execução do comando.

    InvokeId

    string

    O ID de execução do comando.

    t-hz0373jyzxt****
    CreationTime

    string

    A hora em que o comando foi criado, no formato AAAA-MM-DDThh:mm:ss.

    2023-04-27T10:11:58
    CommandId

    string

    O ID do comando.

    c-hy0338xh28r****
    InvocationStatus

    string

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

    • Pending: O sistema está validando ou enviando o comando.

    • Invalid: O tipo de comando ou parâmetro especificado é inválido.

    • Aborted: Falha ao enviar o comando para a instância. A instância deve estar em execução e o comando deve ser entregue em até 1 minuto.

    • Running: O comando está em execução na instância.

    • 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: Ocorreu uma exceção durante a execução do comando e o comando não pode continuar.

    • Timeout: A execução do comando expirou.

    • Cancelled: A ação de execução do comando foi cancelada e o comando nunca foi iniciado.

    • Stopping: A execução do comando está sendo interrompida.

    • 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 caminho no qual o comando foi executado.

    c:\wwwroot
    Timeout

    integer

    O período de tempo limite, em segundos.

    60
    CommandContent

    string

    O conteúdo do comando.

    echo 123
    Parameters

    string

    Os parâmetros personalizados incluídos no comando. Se não existirem parâmetros, o valor padrão é {}.

    {}
    InvokeInstances

    array<object>

    A lista de instâncias de destino para execução.

    object

    A estrutura de informações da instância de destino.

    InstanceId

    string

    O ID da instância do servidor de aplicação simples.

    2445f4aecdac4b71ba2c7e3a7ccf****
    StartTime

    string

    A hora em que o comando começou a ser executado na instância. A hora é exibida em UTC (Z) no formato AAAA-MM-DDThh:mm:ssZ.

    2023-05-09T03:32:24Z
    FinishTime

    string

    A hora em que o processo do comando terminou. A hora é exibida em UTC (Z) no formato AAAA-MM-DDThh:mm:ssZ.

    2023-04-03T02:42:29Z
    InvocationStatus

    string

    O status de execução do comando em uma única instância. Valores válidos:

    • Pending: O sistema está validando ou enviando o comando.

    • Invalid: O tipo de comando ou parâmetro especificado é inválido.

    • Aborted: Falha ao enviar o comando para a instância. A instância deve estar em execução e o comando deve ser entregue em até 1 minuto.

    • Running: O comando está em execução na instância.

    • Success:

      • Tarefa única: A execução do comando foi concluída e o código de saída é 0.

      • Tarefa agendada: A última execução foi bem-sucedida com um código de saída 0, e o agendamento especificado terminou.

    • Failed:

      • Tarefa única: A execução do comando foi concluída e o código de saída não é 0.

      • Tarefa agendada: A última execução foi bem-sucedida com um código de saída diferente de 0, e o agendamento especificado será abortado.

    • Error: Ocorreu uma exceção durante a execução do comando e o comando não pode continuar.

    • Timeout: A execução do comando expirou.

    • Cancelled: A ação de execução do comando foi cancelada e o comando nunca foi iniciado.

    • Stopping: A tarefa está sendo interrompida.

    • Terminated: O comando foi encerrado durante a execução.

    Running
    Output

    string

    As informações de saída da execução do comando.

    OutputMsg
    ExitCode

    integer

    O código de saída do comando.

    • Para instâncias Linux, este é o código de saída do comando Shell.

    • Para instâncias Windows, este é o código de saída do comando Bat ou PowerShell.

    0
    ErrorInfo

    string

    Os detalhes da falha de entrega ou de execução do comando. Valores válidos:

    • Empty: O comando foi executado normalmente.

    • the specified instance does not exists: A instância especificada não existe ou foi liberada.

    • the instance has released when create task: A instância foi liberada durante a execução do comando.

    • the instance is not running when create task: A instância não estava em execução quando o comando foi executado.

    • the command is not applicable: O comando não é aplicável à instância especificada.

    • the specified account does not exists: A conta especificada não existe.

    • the specified directory does not exists: O diretório especificado não existe.

    • the cron job expression is invalid: A expressão cron especificada é inválida.

    • the aliyun service is not running on the instance: O Agente do Cloud Assistant não está em execução.

    • the aliyun service in the instance does not response: O Agente do Cloud Assistant não está respondendo.

    • the aliyun service in the instance is upgrading now: O Agente do Cloud Assistant está sendo atualizado.

    • the aliyun service in the instance need upgrade: O Agente do Cloud Assistant precisa ser atualizado.

    • the command delivery has been timeout: A entrega do comando expirou.

    • the command execution has been timeout: A execução do comando expirou.

    • the command execution got an exception: Ocorreu uma exceção durante a execução do comando.

    • the command execution has been interrupted: A execução do comando foi interrompida.

    • the command execution exit code is not zero: A execução do comando foi concluída com um código de saída diferente de zero.

    the specified instance does not exists
    ErrorCode

    string

    O código de erro para a falha de entrega ou de execução do comando. Valores válidos:

    • Empty: O comando foi executado normalmente.

    • InstanceNotExists: A instância especificada não existe ou foi liberada.

    • InstanceReleased: A instância foi liberada durante a execução do comando.

    • InstanceNotRunning: A instância não estava em execução quando o comando foi executado.

    • CommandNotApplicable: O comando não é aplicável à instância especificada.

    • AccountNotExists: A conta especificada não existe.

    • DirectoryNotExists: O diretório especificado não existe.

    • BadCronExpression: A expressão cron especificada é inválida.

    • ClientNotRunning: O Agente do Cloud Assistant não está em execução.

    • ClientNotResponse: O Agente do Cloud Assistant não está respondendo.

    • ClientIsUpgrading: O Agente do Cloud Assistant está sendo atualizado.

    • ClientNeedUpgrade: O Agente do Cloud Assistant precisa ser atualizado.

    • DeliveryTimeout: A entrega do comando expirou.

    • ExecutionTimeout: A execução do comando expirou.

    • ExecutionException: Ocorreu uma exceção durante a execução do comando.

    • ExecutionInterrupted: A execução do comando foi interrompida.

    • ExitCodeNonzero: A execução do comando foi concluída com um código de saída diferente de zero.

    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.