Todos os produtos
Search
Central de documentação

ApsaraDB for MongoDB:DescribeHistoryTasksStat

Última atualização: Jun 28, 2026

Consulta a visão geral de uma tarefa no centro de tarefas.

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

dds:DescribeHistoryTasksStat

list

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Sim

O ID da região do evento pendente. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

cn-beijing

Status

string

Não

O status da tarefa. Valores válidos:

  • Scheduled: A tarefa está aguardando execução.

  • Running: A tarefa está em execução.

  • Succeed: A tarefa foi bem-sucedida.

  • Failed: A tarefa falhou.

  • Cancelling: A tarefa está sendo encerrada.

  • Canceled: A tarefa foi encerrada.

  • Waiting: A tarefa está aguardando o horário agendado.

Separe vários estados com vírgulas (,). Este parâmetro está vazio por padrão, o que indica que as tarefas em todos os estados são consultadas.

Succeed

InstanceId

string

Não

O ID da instância. Separe vários IDs de instância com vírgulas (,). Você pode especificar até 30 IDs de instância. Este parâmetro está vazio por padrão, o que indica que as tarefas de todas as instâncias são consultadas.

dds-8vb38f0e7933xxxx

TaskId

string

Não

O ID da tarefa. Separe vários IDs de tarefa com vírgulas (,). Você pode especificar até 30 IDs de tarefa. Este parâmetro está vazio por padrão, o que indica que todas as tarefas são consultadas.

t-0mq1yyhm3ffl2bxxxx

TaskType

string

Não

O tipo de tarefa. Este parâmetro é vazio por padrão, o que indica que todos os tipos de tarefas são consultados. Valores válidos:

  • CreateIns: Cria uma instância.

  • DeleteIns: Exclui uma instância.

  • ChangeVariable: Modifica as configurações de parâmetro de uma instância.

  • ModifyInsConfig: Altera as configurações de uma instância.

  • RestartIns: Reinicia uma instância.

  • HaSwitch: Executa uma alternância primária/secundária em uma instância.

  • CloneIns: Clona uma instância.

  • KernelVersionUpgrade: Atualiza a versão secundária de uma instância.

  • ProxyVersionUpgrade: Atualiza a versão do agente de uma instância.

  • ModifyAccount: Altera a conta de uma instância.

  • ModifyInsSpec: Altera as especificações de uma instância ou executa uma migração de dados na instância.

  • CreateReadIns: Cria uma instância somente leitura.

  • StartIns: Inicia uma instância.

  • StopIns: Para uma instância.

  • ModifyNetwork: Modifica o tipo de rede de uma instância.

  • LockIns: Bloqueia uma instância.

  • UnlockIns: Desbloqueia uma instância.

  • DiskOnlineExpansion: Expande os discos de uma instância online.

  • StorageOnlineExpansion: Expande a capacidade de armazenamento de uma instância online.

  • AddInsNode: Adiciona um nó a uma instância.

  • DeleteInsNode: Exclui um nó de uma instância.

  • ManualBackupIns: Faz backup manual de uma instância.

  • ModifyInsStorageType: Modifica o tipo de armazenamento de uma instância.

DeleteIns

FromStartTime

string

Sim

A hora de início da tarefa de O&M a ser executada. Especifique a hora no padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Você pode consultar dados dos últimos 30 dias.

2023-04-16T02:46:21Z

ToStartTime

string

Sim

A hora de término da tarefa de O&M a ser executada. Especifique a hora no padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Você pode consultar dados dos últimos 30 dias.

2023-05-16T02:15:52Z

FromExecTime

integer

Não

A duração mínima de execução da tarefa. Este parâmetro é usado para filtrar tarefas cuja duração de execução seja maior que a duração mínima de execução. Unidade: segundos. O valor padrão é 0, o que indica que nenhum limite é imposto para a consulta.

0

ToExecTime

integer

Não

A duração máxima de execução da tarefa. Este parâmetro é usado para filtrar tarefas cuja duração de execução seja menor ou igual à duração máxima de execução. Unidade: segundos. O valor padrão é 0, o que indica que nenhum limite é imposto para a consulta.

0

ResourceGroupId

string

Não

O ID do grupo de recursos.

rg-acfmyiu4ekp****

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação.

FC724D23-XXXX-XXXX-ABB1-606C935AE7FD

Items

array<object>

Os objetos de tarefa.

object

Status

string

O status da tarefa. Valores válidos:

  • Scheduled: A tarefa está aguardando execução.

  • Running: A tarefa está em execução.

  • Succeed: A tarefa foi bem-sucedida.

  • Failed: A tarefa falhou.

  • Cancelling: A tarefa está sendo encerrada.

  • Canceled: A tarefa foi encerrada.

  • Waiting: A tarefa está aguardando o horário agendado.

Succeed

TotalCount

integer

O número de tarefas em um estado especificado.

2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FC724D23-XXXX-XXXX-ABB1-606C935AE7FD",
  "Items": [
    {
      "Status": "Succeed",
      "TotalCount": 2
    }
  ]
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 Param.Invalid Param invalid
400 Param.Invalid.TimeEndBeforeStart Param invalid. End time before start time

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.