Todos os produtos
Search

Este produto

    :DescribeInvocations

    Central de documentação

    :DescribeInvocations

    Última atualização: Jun 22, 2026

    Consulta a lista de tarefas e o status de execução dos comandos do Cloud Assistant.

    Notas de uso

    • Após executar um comando, ele pode não ser bem-sucedido ou retornar os resultados esperados. Chame esta operação para consultar os resultados da execução.
    • É possível consultar informações sobre tarefas de comandos das últimas quatro semanas. Até 100.000 registros de tarefas podem ser retidos.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

    Parâmetros de solicitação

    Parâmetro

    Tipo

    Obrigatório

    Exemplo

    Descrição
    Action String Sim DescribeInvocations

    A operação que você deseja executar. Defina o valor como DescribeInvocations.

    RegionId String Sim cn-hangzhou

    O ID da região do comando. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

    ResourceGroupId String Não rg-bp67acfmxazb4p****

    O ID do grupo de recursos. Ao definir este parâmetro, a consulta retorna os resultados de execução de comandos do grupo de recursos especificado.

    InvokeId String Não t-hz0jdfwd9f****

    O ID da tarefa de comando.

    CommandId String Não c-hz0jdfwcsr****

    O ID do comando. Chame a operação DescribeCommands para consultar todos os IDs de comandos disponíveis.

    CommandName String Não CommandTestName

    O nome do comando. Se este parâmetro e InstanceId forem especificados simultaneamente, este parâmetro não terá efeito.

    CommandType String Não RunShellScript

    O tipo do 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
    Timed Boolean Não true

    Especifica se o comando será executado automaticamente. Valores válidos:

    • true: o comando é executado chamando a operação RunCommand ou InvokeCommand com RepeatMode definido como Period, NextRebootOnly ou EveryReboot.
    • false: o comando atende aos seguintes requisitos:
      • O comando é executado chamando a operação RunCommand ou InvokeCommand com RepeatMode definido como Once.
      • O comando possui tarefas canceladas, interrompidas ou concluídas.

    Valor padrão: false.

    InvokeStatus String Não Finished

    O status geral de execução da tarefa de comando. O valor deste parâmetro depende dos estados de execução em todas as instâncias envolvidas. Valores válidos:

    • Running:
      • Tarefa agendada: antes de interromper manualmente a execução agendada do comando, o estado geral de execução será sempre Running.
      • Tarefa única: se o comando estiver sendo executado nas instâncias, o estado geral de execução será Running.
    • Finished:
      • Tarefa agendada: o estado geral de execução nunca pode ser Finished.
      • Tarefa única: a execução foi concluída em todas as instâncias, ou a execução foi interrompida manualmente em algumas instâncias e concluída nas demais.
    • Success: se o estado de execução em pelo menos uma instância for Success e o estado nas demais instâncias for Stopped ou Success, o estado geral de execução será Success.
      • Tarefa de execução imediata: a execução foi concluída e o código de saída é 0.
      • Tarefa agendada: a última execução foi concluída e o código de saída foi 0. O período especificado terminou.
    • Failed:
      • Tarefa agendada: o estado geral de execução nunca pode ser Failed.
      • Tarefa única: a execução falha em todas as instâncias.
    • Stopped: a tarefa foi interrompida.
    • Stopping: a tarefa está sendo interrompida.
    • PartialFailed: a tarefa falha em algumas instâncias. Se InstanceId for especificado, InvokeStatus não terá efeito.
    InstanceId String Não i-bp1i7gg30r52z2em****

    O ID da instância. Ao especificar este parâmetro, o sistema consulta todos os registros de execução de todos os comandos executados na instância.

    ContentEncoding String Não PlainText

    O modo de codificação dos valores de CommandContent e Output na resposta. Valores válidos:

    • PlainText: retorna o conteúdo original do comando e as saídas do comando.
    • Base64: retorna o conteúdo e as saídas do comando codificados em Base64.

    Valor padrão: Base64.

    IncludeOutput Boolean Não false

    Especifica se as saídas do comando devem ser retornadas na resposta.

    • true: retorna as saídas do comando. Quando este parâmetro é definido como true, é necessário especificar InvokeId, InstanceId ou ambos.
    • false: não retorna as saídas do comando.

    Valor padrão: false.

    PageNumber Long Não 1

    O número da página.

    As páginas começam a partir da página 1.

    Valor padrão: 1.

    PageSize Long Não 10

    O número de entradas por página.

    Valores válidos: 1 a 50.

    Valor padrão: 10.

    RepeatMode String Não Once

    O modo de execução do comando. Se este parâmetro e InstanceId forem especificados simultaneamente, este parâmetro não terá efeito. Valores válidos:

    • Once: o comando é executado imediatamente.
    • Period: o comando é executado de forma agendada.
    • NextRebootOnly: o comando é executado na próxima inicialização da instância.
    • EveryReboot: o comando é executado toda vez que a instância é iniciada.

    Este parâmetro é vazio por padrão, o que indica que comandos executados em todos os modos são consultados.

    Tag.N.Key String Não TestKey

    A chave da tag N da tarefa de comando. Valores válidos de N: 1 a 20. A chave de tag não pode ser uma string vazia.

    Se você especificar uma única tag para consultar recursos, até 1.000 recursos aos quais a tag foi adicionada serão retornados. Se você especificar múltiplas tags, até 1.000 recursos aos quais todas as tags especificadas foram adicionadas serão retornados. Para consultar mais de 1.000 recursos com as tags especificadas, chame a operação ListTagResources.

    A chave de tag pode ter até 64 caracteres e não pode conter http:// ou https://. A chave de tag não pode começar com acs: ou aliyun.

    Tag.N.Value String Não TestValue

    O valor da tag N da tarefa de comando. Valores válidos de N: 1 a 20. O valor de tag pode ser uma string vazia.

    O valor de tag pode ter até 128 caracteres e não pode conter http:// ou https://.

    Parâmetros de resposta

    Parâmetro

    Tipo

    Exemplo

    Descrição
    PageSize Long 10

    O número de entradas por página.

    RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    O ID da solicitação.

    PageNumber Long 1

    O número da página.

    TotalCount Long 1

    O número total de comandos.

    Invocations Array of Invocation

    As tarefas de comando consultadas.

    Invocation
    CreationTime String 2020-01-19T09:15:46Z

    A hora em que a tarefa de comando foi criada.

    Frequency String 0 */20 * * * *

    O agendamento de execução do comando.

    InvocationStatus String Running

    O status geral de execução da tarefa de comando. O valor deste parâmetro depende dos estados de execução em todas as instâncias envolvidas. Valores válidos:

    • Pending: o comando estava sendo verificado ou enviado. Se o estado de execução for Pending em pelo menos uma instância, o estado geral de execução será Pending.
    • Scheduled: o comando agendado foi enviado e aguarda execução. Se o estado de execução for Scheduled em pelo menos uma instância, o estado geral de execução será Scheduled.
    • Running: o comando estava sendo executado nas instâncias. Se o estado de execução for Running em pelo menos uma instância, o estado geral de execução será Running.
    • Success: se o estado de execução em pelo menos uma instância for Success e o estado nas demais instâncias for Stopped ou Success, o estado geral de execução será Success.
      • Tarefa de execução imediata: a tarefa de comando foi concluída e o código de saída foi 0.
      • Tarefa agendada: a última execução foi concluída e o código de saída foi 0. O período especificado terminou.
    • Failed: se o estado de execução em todas as instâncias for Stopped ou Failed, o estado geral de execução será Failed. Se o estado de execução em uma instância for um dos seguintes valores, Failed será retornado como o estado geral de execução:
      • Invalid: o comando é inválido.
      • Aborted: o envio do comando falhou.
      • Failed: a tarefa de comando foi concluída, mas o código de saída não foi 0.
      • Timeout: a execução expirou.
      • Error: ocorreu um erro durante a execução do comando.
    • Stopping: a tarefa de comando estava sendo interrompida. Se o estado de execução de pelo menos uma instância for Stopping, o estado geral de execução será Stopping.
    • Stopped: a tarefa de comando foi interrompida. Se o estado de execução em todas as instâncias for Stopped, o estado geral de execução será Stopped. Se o estado de execução em uma instância for um dos seguintes valores, Stopped será retornado como o estado geral de execução:
      • Cancelled: a tarefa de comando foi cancelada.
      • Terminated: a tarefa de comando foi encerrada.
    • PartialFailed: a tarefa de comando foi bem-sucedida em algumas instâncias e falhou em outras. Quando o estado de execução for Success em algumas instâncias e Failed ou Stopped nas demais, o estado geral de execução será PartialFailed.
    null O parâmetro InvokeStatus na resposta funciona de forma semelhante a este parâmetro. Recomendamos verificar o valor deste parâmetro.
    RepeatMode String Once

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

    • Once: o comando é executado imediatamente.
    • Period: o comando é executado de forma agendada.
    • NextRebootOnly: o comando é executado na próxima inicialização da instância.
    • EveryReboot: o comando é executado toda vez que a instância é iniciada.
    CommandId String c-hz0jdfwcsr****

    O ID do comando.

    CommandType String RunShellScript

    O tipo do comando.

    InvokeStatus String Finished

    O status geral de execução da tarefa de comando.

    null Recomendamos ignorar este parâmetro e verificar o valor de InvocationStatus na resposta para o estado geral de execução.
    Parameters String {}

    Os parâmetros personalizados no comando.

    Timed Boolean false

    Indica se o comando será executado automaticamente.

    CommandContent String cnBtIC1xYSB8IGdyZXAgdnNm****

    O conteúdo do comando.

    • Se ContentEncoding for definido como PlainText na solicitação, o conteúdo original do comando será retornado.
    • Se ContentEncoding for definido como Base64 na solicitação, o conteúdo do comando codificado em Base64 será retornado.
    CommandName String CommandTestName

    O nome do comando.

    CommandDescription String testDescription

    A descrição do comando.

    InvokeId String t-hz0jdfwd9f****

    O ID da tarefa de comando.

    Username String test

    O nome de usuário usado para executar o comando na instância.

    WorkingDir String /home/

    O caminho de execução do comando.

    Timeout Long 60

    O período máximo de timeout para execuções de comandos na instância. Unidade: segundos.

    Quando um comando não pode ser executado, ocorre um erro de timeout. Quando a execução de um comando expira, o Cloud Assistant Agent encerra forçosamente o processo do comando cancelando o ID do processo (PID).

    ContainerId String ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****

    O ID do contêiner.

    ContainerName String test-container

    O nome do contêiner.

    InvokeInstances Array of InvokeInstance

    As instâncias nas quais o comando foi executado.

    InvokeInstance
    CreationTime String 2019-12-20T06:15:54Z

    A hora em que o comando começou a ser executado na instância.

    UpdateTime String 2020-01-19T09:15:47Z

    A hora em que o status de execução foi atualizado.

    FinishTime String 2019-12-20T06:15:56Z

    A hora em que o processo do comando foi encerrado.

    InvocationStatus String Success

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

    • Pending: o comando estava sendo verificado ou enviado.
    • Invalid: o tipo de comando ou parâmetro especificado era inválido.
    • Aborted: o envio do comando falhou. Para enviar um comando a uma instância, certifique-se de que a instância esteja no estado Running e que o comando possa ser enviado em até 1 minuto.
    • Running: o comando estava sendo executado na instância.
    • Success:
      • Comando de execução única: a execução foi concluída e o código de saída foi 0.
      • Comando de execução agendada: a execução anterior foi concluída e o código de saída foi 0. O período especificado terminou.
    • Failed:
      • Comando de execução única: a execução foi concluída, mas o código de saída não foi 0.
      • Comando de execução agendada: a execução anterior foi concluída, mas o código de saída não foi 0. O período especificado estava prestes a terminar.
    • Error: a execução não pôde prosseguir devido a uma exceção.
    • Timeout: a execução expirou.
    • Cancelled: a execução foi cancelada e o comando não foi executado.
    • Stopping: a tarefa de comando estava sendo interrompida.
    • Terminated: a execução foi encerrada durante a execução do comando.
    • Scheduled:
      • Comando de execução única: o estado geral de execução nunca pode ser Scheduled.
      • Comando de execução agendada: o comando estava aguardando execução.
    Repeats Integer 0

    O número de vezes que o comando foi executado na instância.

    • Se o comando estiver configurado para execução única, o valor é 0 ou 1.
    • Se o comando estiver configurado para execução agendada, o valor é o número de vezes que o comando foi executado.
    InstanceId String i-bp1i7gg30r52z2em****

    O ID da instância.

    Output String OutPutTestmsg

    A saída do comando.

    • Se ContentEncoding for definido como PlainText na solicitação, a saída original do comando será retornada.
    • Se ContentEncoding for definido como Base64 na solicitação, a saída do comando codificada em Base64 será retornada.
    Dropped Integer 0

    O tamanho do texto de Output truncado e descartado quando o valor de Output excede 24 KB.

    StopTime String 2020-01-19T09:15:47Z

    A hora em que a tarefa de comando foi interrompida. Se você chamar a operação StopInvocation para interromper a tarefa de comando, o valor deste parâmetro será a hora em que a operação foi chamada.

    ExitCode Long 0

    O código de saída da execução. Valores válidos:

    • Para instâncias Linux, o código de saída é o código de saída do processo shell.
    • Para instâncias Windows, o código de saída é o código de saída do processo em lote ou PowerShell.
    StartTime String 2019-12-20T06:15:55Z

    A hora em que o comando começou a ser executado na instância.

    ErrorInfo String the specified instance does not exists

    O motivo pelo qual o envio ou a execução do comando falhou. Valores válidos:

    • Se este parâmetro estiver vazio, o comando foi executado normalmente.
    • the specified instance does not exist
    • the instance has released when create task
    • the instance is not running when create task
    • the command is not applicable
    • the specified account does not exist
    • the specified directory does not exist
    • the cron job expression is invalid
    • the aliyun service is not running on the instance
    • the aliyun service in the instance does not response
    • the aliyun service in the instance is upgrading now
    • the aliyun service in the instance need upgrade
    • the command delivery has been timeout
    • the command execution has been timeout
    • the command execution got an exception
    • the command execution has been interrupted
    • the command execution exit code is not zero
    • the specified instance has been released
    Timed Boolean false

    Indica se o comando será executado automaticamente.

    ErrorCode String InstanceNotExists

    O código que indica o motivo da falha no envio ou na execução do comando. Valores válidos:

    • Se este parâmetro estiver vazio, o comando foi executado normalmente.
    • InstanceNotExists: a instância não existia 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 começou a ser executado.
    • CommandNotApplicable: o comando não era aplicável à instância especificada.
    • AccountNotExists: a conta especificada não existia.
    • DirectoryNotExists: o diretório especificado não existia.
    • BadCronExpression: a expressão cron usada para especificar um agendamento era inválida.
    • ClientNotRunning: o Cloud Assistant Agent não estava em execução.
    • ClientNotResponse: o Cloud Assistant Agent não respondeu.
    • ClientIsUpgrading: o Cloud Assistant Agent estava sendo atualizado.
    • ClientNeedUpgrade: o Cloud Assistant Agent precisa ser atualizado.
    • DeliveryTimeout: a solicitação de envio do comando expirou.
    • ExecutionTimeout: a execução expirou.
    • ExecutionException: ocorreu uma exceção durante a execução do comando.
    • ExecutionInterrupted: a tarefa de comando foi interrompida.
    • ExitCodeNonzero: a tarefa de comando foi concluída, mas o código de saída não foi 0.
    InstanceInvokeStatus String Finished

    O estado de execução em uma única instância.

    null Recomendamos ignorar este parâmetro e verificar o valor de InvocationStatus na resposta para o estado geral de execução.
    Tags Array of Tag

    As tags da tarefa de comando.

    Tag
    TagKey String owner

    A chave de tag da tarefa de comando.

    TagValue String zhangsan

    O valor de tag da tarefa de comando.

    Exemplos

    Exemplos de solicitações

    http(s)://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-hz0jdfwd9f****
&CommandId=c-hz0jdfwcsr****
&CommandName=CommandTestName
&CommandType=RunShellScript
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=10
&RepeatMode=Once
&<Common request parameters>

    Exemplos de respostas bem-sucedidas

    Formato XML

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInvocationsResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Invocations>
        <Invocation>
            <CreationTime>2020-01-19T09:15:46Z</CreationTime>
            <Frequency>0 */20 * * * *</Frequency>
            <InvocationStatus>Running</InvocationStatus>
            <RepeatMode>Once</RepeatMode>
            <CommandId>c-hz0jdfwcsr****</CommandId>
            <CommandType>RunShellScript</CommandType>
            <InvokeStatus>Finished</InvokeStatus>
            <Parameters>{}</Parameters>
            <Timed>false</Timed>
            <CommandContent>cnBtIC1xYSB8IGdyZXAgdnNm****</CommandContent>
            <CommandName>CommandTestName</CommandName>
            <CommandDescription>testDescription</CommandDescription>
            <InvokeId>t-hz0jdfwd9f****</InvokeId>
            <Username>test</Username>
            <WorkingDir>/home/</WorkingDir>
            <Timeout>60</Timeout>
            <ContainerId>ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****</ContainerId>
            <ContainerName>test-container</ContainerName>
            <InvokeInstances>
                <InvokeInstance>
                    <CreationTime>2019-12-20T06:15:54Z</CreationTime>
                    <UpdateTime>2020-01-19T09:15:47Z</UpdateTime>
                    <FinishTime>2019-12-20T06:15:56Z</FinishTime>
                    <InvocationStatus>Success</InvocationStatus>
                    <Repeats>0</Repeats>
                    <InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
                    <Output>OutPutTestmsg</Output>
                    <Dropped>0</Dropped>
                    <StopTime>2020-01-19T09:15:47Z</StopTime>
                    <ExitCode>0</ExitCode>
                    <StartTime>2019-12-20T06:15:55Z</StartTime>
                    <ErrorInfo>the specified instance does not exists</ErrorInfo>
                    <Timed>false</Timed>
                    <ErrorCode>InstanceNotExists</ErrorCode>
                    <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                </InvokeInstance>
                <Tags>
                    <TagKey>owner</TagKey>
                    <TagValue>zhangsan</TagValue>
                </Tags>
            </InvokeInstances>
        </Invocation>
    </Invocations>
</DescribeInvocationsResponse>

    Formato JSON

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Invocations" : {
    "Invocation" : [ {
      "CreationTime" : "2020-01-19T09:15:46Z",
      "Frequency" : "0 */20 * * * *",
      "InvocationStatus" : "Running",
      "RepeatMode" : "Once",
      "CommandId" : "c-hz0jdfwcsr****",
      "CommandType" : "RunShellScript",
      "InvokeStatus" : "Finished",
      "Parameters" : "{}",
      "Timed" : false,
      "CommandContent" : "cnBtIC1xYSB8IGdyZXAgdnNm****",
      "CommandName" : "CommandTestName",
      "CommandDescription" : "testDescription",
      "InvokeId" : "t-hz0jdfwd9f****",
      "Username" : "test",
      "WorkingDir" : "/home/",
      "Timeout" : 60,
      "ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
      "ContainerName" : "test-container",
      "InvokeInstances" : {
        "InvokeInstance" : [ {
          "CreationTime" : "2019-12-20T06:15:54Z",
          "UpdateTime" : "2020-01-19T09:15:47Z",
          "FinishTime" : "2019-12-20T06:15:56Z",
          "InvocationStatus" : "Success",
          "Repeats" : 0,
          "InstanceId" : "i-bp1i7gg30r52z2em****",
          "Output" : "OutPutTestmsg",
          "Dropped" : 0,
          "StopTime" : "2020-01-19T09:15:47Z",
          "ExitCode" : 0,
          "StartTime" : "2019-12-20T06:15:55Z",
          "ErrorInfo" : "the specified instance does not exists",
          "Timed" : false,
          "ErrorCode" : "InstanceNotExists",
          "InstanceInvokeStatus" : "Finished"
        } ],
        "Tags" : [ {
          "TagKey" : "owner",
          "TagValue" : "zhangsan"
        } ]
      }
    } ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 RegionId.ApiNotSupported The api is not supported in this region. Esta operação não pode ser executada na região especificada. Verifique se o valor do parâmetro RegionId é válido.
    400 Duplicate.TagKey The Tag.N.Key contain duplicate key. A chave de tag já existe. As chaves de tag devem ser únicas.
    400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. Valor de Tag.N.Key inválido.
    400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. Valor de Tag.N.Value inválido.
    400 MissingParameter.TagKey You must specify Tag.N.Key. Tag.N.Key é obrigatório.
    400 InvalidParam.PageNumber The specified parameter is invalid. Valor de PageNumber inválido.
    400 InvalidParam.PageSize The specified parameter is invalid. Valor de PageSize inválido.
    403 Operation.Forbidden The operation is not permitted. A operação não é permitida.
    500 InternalError.Dispatch An error occurred when you dispatched the request. Ocorreu um erro ao enviar a solicitação. Tente novamente mais tarde.

    Para obter uma lista de códigos de erro, consulte Códigos de erro de serviço.