Todos os produtos
Search
Central de documentação

ApsaraDB for MongoDB:DescribeHistoryTasks

Última atualização: Jun 28, 2026

Consulta uma lista de tarefas 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:DescribeHistoryTasks

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

Não

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

PageSize

integer

Não

O número de entradas por página. Valores válidos: 10 a 100. Valor padrão: 10.

10

PageNumber

integer

Não

O número da página a ser retornada. O valor deve ser um inteiro positivo. Valor padrão: 1.

1

InstanceType

string

Não

O tipo de instância da instância. Defina o valor como Instance.

Instance

Status

string

Não

O status da tarefa. Valores válidos:

  • Scheduled: A tarefa está aguardando para ser executada.

  • 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 múltiplos estados com vírgulas (,). Este parâmetro é vazio por padrão, o que indica que tarefas em todos os estados são consultadas.

Succeed,Running,Waiting

InstanceId

string

Não

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

dds-8vb38f0e7933xxxx

TaskId

string

Não

O ID da tarefa. Separe múltiplos IDs de tarefa com vírgulas (,). Você pode especificar até 30 IDs de tarefa. Este parâmetro é 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 é deixado vazio por padrão, o que indica que todos os tipos de tarefas são consultados. Valores válidos:

  • CreateIns: Criar uma instância.

  • DeleteIns: Excluir uma instância.

  • ChangeVariable: Modificar configurações de parâmetros de uma instância.

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

  • RestartIns: Reiniciar uma instância.

  • HaSwitch: Realizar uma alternância primário/secundário em uma instância.

  • CloneIns: Clonar uma instância.

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

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

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

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

  • CreateReadIns: Criar uma instância somente leitura.

  • StartIns: Iniciar uma instância.

  • StopIns: Parar uma instância.

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

  • LockIns: Bloquear uma instância.

  • UnlockIns: Desbloquear uma instância.

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

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

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

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

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

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

DeleteInsNode

FromStartTime

string

Sim

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

2023-03-15T03:41:26Z

ToStartTime

string

Sim

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

2023-03-16T07:21:31Z

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 é 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 é 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-aek2inrfrnw3xby

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

PageNumber

integer

O número da página retornada.

1

RequestId

string

O ID da solicitação.

3C4A2494-XXXX-XXXX-93CF-548DB3375193

PageSize

integer

O número máximo de entradas retornadas por página.

10

TotalCount

integer

O número total de tarefas que atendem a essas condições sem considerar a paginação.

5

Items

array<object>

Os objetos de tarefa.

object

Status

string

O status da tarefa. Valores válidos:

  • Scheduled: A tarefa está aguardando para ser executada.

  • 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

TaskId

string

O ID da tarefa.

t-0mq1yyhm3ffl2bxxxx

CurrentStepName

string

O nome da etapa atual. Se este parâmetro for deixado vazio, a tarefa não foi iniciada.

exec_task

StartTime

string

A hora de início da tarefa de O&M realizada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.

2023-02-11T02:33Z

EndTime

string

A hora de término da tarefa de O&M realizada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.

2023-03-16T02:59Z

TaskType

string

O tipo de tarefa.

  • CreateIns: Criar uma instância.

  • DeleteIns: Excluir uma instância.

  • ChangeVariable: Modificar configurações de parâmetros de uma instância.

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

  • RestartIns: Reiniciar uma instância.

  • HaSwitch: Realizar uma alternância primário/secundário em uma instância.

  • CloneIns: Clonar uma instância.

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

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

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

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

  • CreateReadIns: Criar uma instância somente leitura.

  • StartIns: Iniciar uma instância.

  • StopIns: Parar uma instância.

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

  • LockIns: Bloquear uma instância.

  • UnlockIns: Desbloquear uma instância.

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

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

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

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

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

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

CreateIns

RemainTime

integer

O tempo estimado restante de execução. Unidade: segundos. O valor 0 indica que a tarefa foi concluída.

1000

Progress

number

O progresso atual da tarefa. Os valores válidos variam de 0 a 100.

100.0

RegionId

string

O ID da região da instância.

cn-hangzhou

InstanceType

string

O tipo de instância da instância. O valor é fixo como Instance.

Instance

InstanceId

string

O ID da instância.

dds-t4n18194768fxxxx

InstanceName

string

O nome da instância.

test-dds

DbType

string

O tipo de banco de dados. O valor é fixo como mongodb.

mongodb

Product

string

O produto. O valor é fixo como dds.

dds

TaskDetail

string

Os detalhes da tarefa. Os detalhes da tarefa variam com base no valor do parâmetro taskType.

{\"callerUid\":\"test\"}

ReasonCode

string

O motivo pelo qual a tarefa atual foi iniciada.

Minor version upgrade

ActionInfo

string

Um conjunto de ações permitidas que podem ser executadas na tarefa. O sistema faz a correspondência do nome da etapa atual e do status da tarefa com as ações disponíveis especificadas por ActionInfo. Se nenhuma ação correspondente for encontrada, o status atual da tarefa não suporta nenhuma ação. Exemplo:

   "steps": [
    {
      "step_name": "exec_task", // O nome da etapa, que corresponde ao valor de CurrentStepName.
      "action_info": {    // As ações suportadas para esta etapa.
        "Waiting": [      // O status, que corresponde ao valor de Status.
          "modifySwitchTime" // A ação. Múltiplas ações são suportadas.
        ]
      }
    },
    {
      "step_name": "init_task", // O nome da etapa.
      "action_info": {    // As ações suportadas para esta etapa.
        "Running": [      // O status.
          "cancel",       // A ação.
          "pause"
        ]
      }
    }
  ]
}

O sistema pode suportar as seguintes ações:

  • retry: realiza outra tentativa.

  • cancel: realiza um cancelamento.

  • modifySwitchTime: altera o horário de alternância ou restauração.

`{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}`

Uid

string

O ID do usuário ao qual o recurso pertence.

141345906006****

CallerSource

string

A origem da solicitação. Valores válidos: System e User.

System

CallerUid

string

O ID do usuário que fez a solicitação. Se CallerSource estiver definido como User, CallerUid indica o ID exclusivo (UID) do usuário.

141345906006****

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mq1yyhm3ffl2bxxxx",
      "CurrentStepName": "exec_task",
      "StartTime": "2023-02-11T02:33Z",
      "EndTime": "2023-03-16T02:59Z",
      "TaskType": "CreateIns",
      "RemainTime": 1000,
      "Progress": 100,
      "RegionId": "cn-hangzhou",
      "InstanceType": "Instance",
      "InstanceId": "dds-t4n18194768fxxxx",
      "InstanceName": "test-dds",
      "DbType": "mongodb",
      "Product": "dds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "Minor version upgrade",
      "ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
      "Uid": "141345906006****",
      "CallerSource": "System",
      "CallerUid": "141345906006****"
    }
  ]
}

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.