Todos os produtos
Search
Central de documentação

PolarDB:DescribeHistoryTasks

Última atualização: Jun 28, 2026

Obtém uma lista de tarefas administrativas históricas para instâncias do PolarDB for MySQL, como alterações de parâmetros e reinicializações de instâncias.

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

polardb:DescribeHistoryTasks

get

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Não

O ID da região.

Nota

Para mais informações, consulte DescribeRegions.

cn-beijing

PageSize

integer

Não

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

10

PageNumber

integer

Não

O número da página. Valores válidos: inteiros positivos. Valor padrão: 1.

1

InstanceType

string

Não

Atualmente, apenas Instance é suportado.

Instance

Status

string

Não

O status da tarefa. Valores válidos:

  • Scheduled: aguardando execução

  • Running: em execução

  • Succeed: executado com sucesso

  • Cancelling: parando

  • Canceled: parado

  • Waiting: aguardando horário predefinido

Você pode fornecer uma lista separada por vírgulas. Valor padrão: vazio, o que indica todos os status.

Running

InstanceId

string

Não

O ID do recurso pelo qual filtrar. Você pode fornecer uma lista separada por vírgulas com até 30 IDs. Valor padrão: vazio, indicando nenhuma restrição.

Nota

Atualmente, apenas IDs de clusters do PolarDB são suportados.

pc-2zed3m89cw***

TaskId

string

Não

O ID da tarefa. Você pode fornecer uma lista separada por vírgulas com até 30 IDs. Valor padrão: vazio, indicando nenhuma restrição.

t-0mqi38ho0cgjv***

TaskType

string

Não

O tipo de tarefa. Você pode fornecer uma lista separada por vírgulas com até 30 tipos de tarefa. Valor padrão: vazio, indicando nenhuma restrição.

ChangeVariable

FromStartTime

string

Sim

O início do intervalo de tempo a ser consultado, com base na hora de início da tarefa. O horário segue o padrão ISO8601 e deve estar no fuso horário UTC+0. Formato: yyyy-MM-ddTHH:mm:ssZ.

O horário mais antigo suportado é de 30 dias atrás. Se o horário especificado for superior a 30 dias atrás, ele será automaticamente convertido para 30 dias atrás.

2025-01-02T11:31:03Z

ToStartTime

string

Sim

O fim do intervalo de tempo a ser consultado, com base na hora de início da tarefa. O horário segue o padrão ISO8601 e deve estar no fuso horário UTC+0. Formato: yyyy-MM-ddTHH:mm:ssZ.

2025-01-03T11:31:03Z

FromExecTime

integer

Não

O tempo mínimo de execução da tarefa em segundos. Filtra tarefas que levaram mais tempo que esse valor. Valor padrão: 0.

0

ToExecTime

integer

Não

O tempo máximo de execução da tarefa em segundos. Filtra tarefas que levaram menos tempo que esse valor. Valor padrão: 0.

0

ResourceGroupId

string

Não

O ID do grupo de recursos.

rg-************

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Detalhes dos parâmetros retornados.

PageNumber

integer

O número da página do resultado da consulta.

1

RequestId

string

O ID exclusivo da solicitação.

F90D7C14-2D1C-5B88-9CD1-23AB2CF89***

PageSize

integer

O número de registros por página.

10

TotalCount

string

O número total de tarefas que atendem às condições, independentemente dos fatores de paginação.

2

Items

array<object>

A lista de tarefas.

object

O objeto da tarefa.

Status

string

O status final da tarefa.

  • Scheduled: aguardando execução

  • Running: em execução

  • Succeed: executado com sucesso

  • Failed: falha na execução

  • Cancelling: parando

  • Canceled: parado

  • Waiting: aguardando horário predefinido

Succeed

TaskId

string

O ID da tarefa.

t-0mqt8qhnw04ipz0***

CurrentStepName

string

O nome da etapa atual em execução. Se este parâmetro estiver vazio, a tarefa não foi iniciada.

finish_task

StartTime

string

A hora de início da tarefa.

2025-03-03T07:25:16Z

EndTime

string

A hora de término da tarefa.

2025-03-03T07:30:57Z

TaskType

string

O tipo de tarefa.

ChangeVariable

RemainTime

integer

O tempo restante estimado de execução, em segundos (s).

Nota

Este valor é apenas para referência. O tempo real de execução prevalece.

0

Progress

number

O progresso de conclusão da tarefa, de 0,0 a 100,0.

100.0

RegionId

string

O ID da região.

cn-beijing

InstanceType

string

O tipo de recurso.

Instance

InstanceId

string

O ID do recurso.

pc-2zed3m89cw***

InstanceName

string

O nome do recurso.

pc-2zed3m89cw***

DbType

string

O tipo de banco de dados.

polardb_mysql

Product

string

O produto.

polardb

TaskDetail

string

Os detalhes da tarefa.

{\"steps\":[{\"step_name\":\"init_task\"},{\"step_name\":\"exec_task\"},{\"step_name\":\"finish_task\"}]}

ReasonCode

string

O motivo para iniciar a tarefa atual.

""

ActionInfo

string

As informações da operação permitida.

Nota

Este recurso ainda não é suportado.

{}

Uid

string

O UID da conta que possui o recurso.

1816563541899***

CallerSource

string

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

  • System: sistema

  • User: usuário

User

CallerUid

string

O ID do usuário solicitante. Se CallerSource for User, este é o UID do usuário.

1816563541899***

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 Param.Invalid The parameter is invalid. The parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.