DescribeTasks - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os detalhes de progresso de tarefas geradas por chamadas de API, como a criação de um cluster.

Descrição da operação

Você pode visualizar os detalhes de progresso de tarefas geradas por chamadas diretas de API, como CreateDBCluster, ou por operações no console do PolarDB, como criar um cluster.
Atualmente, esta operação suporta a visualização dos detalhes de progresso apenas para tarefas geradas ao criar um cluster chamando a operação CreateDBCluster, desde que o parâmetro CreationOption não esteja definido como CreateGdnStandby.

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:DescribeTasks

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Não	O ID do cluster. Nota Especifique `DBNodeId` ou `DBClusterId`. Chame a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo IDs de cluster.	pc-***************
DBNodeId	string	Não	O ID do nó. Nota Especifique `DBNodeId` ou `DBClusterId`. Chame a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo IDs de nó.	pi-***************
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no formato `YYYY-MM-DDThh:mmZ`. O horário deve estar em UTC.	2020-11-30T00:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no formato `YYYY-MM-DDThh:mmZ`. O horário deve estar em UTC.	2020-12-02T03:00Z
Status	string	Não	O status da tarefa. Valores válidos: Waiting: A tarefa está aguardando execução. Running: A tarefa está em execução. Finished: A tarefa está concluída. Closed: A tarefa está encerrada. Pause: A tarefa está pausada. Stop: A tarefa está interrompida. Nota Se você deixar este parâmetro vazio, os detalhes de todas as tarefas no estado Waiting ou Running para o cluster ou nó atual serão retornados. Para consultar tarefas em vários estados, separe os nomes dos estados com uma vírgula (,).	Running
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser um inteiro maior que 0 e que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	integer	O número total de entradas retornadas.	1
PageRecordCount	integer	O número de entradas retornadas na página atual.	30
Tasks	object
Task	array<object>	Os detalhes da tarefa.
	object
FinishTime	string	The time when the task was completed. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.	2020-12-02T02:40:15Z
StepsInfo	string	The details of the subtasks.	[{\"remain\":0,\"name\":\"init_task\",\"progress\":100},{\"remain\":1764,\"name\":\"create_instance\",\"progress\":0},{\"remain\":1,\"name\":\"init_cluster\",\"progress\":0},{\"remain\":2,\"name\":\"create_backup\",\"progress\":0}]
Progress	integer	The progress of the task in percentage.	100
ExpectedFinishTime	string	The estimated end time of the task. This parameter is empty under normal circumstances.	null
BeginTime	string	The time when the task started. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.	2020-12-02T02:39:15Z
TaskErrorCode	string	The error code returned when an error occurs. Nota This parameter is returned only when the task status is Stop.	null
ProgressInfo	string	The description of the task progress. If the task has no progress description, this parameter is empty.	null
CurrentStepName	string	The name of the current subtask.	create_instance
StepProgressInfo	string	The progress of the subtask. For example, `1/4` indicates that the task consists of four subtasks and the first subtask is in progress.	1/4
TaskErrorMessage	string	The error message returned when an error occurs. Nota This parameter is returned only when the task status is Stop.	null
TaskAction	string	The API operation used for the task, such as `CreateDBInstance`.	CreateDBInstance
DBName	string	The database name. Nota This parameter is returned only for tasks related to database operations.	test
Remain	integer	The estimated remaining time of the task. Unit: seconds.	1767
TaskId	string	The task ID.	111111111
EndTime	string	O fim do intervalo de tempo consultado.	2020-12-02T03:00Z
RequestId	string	O ID da solicitação.	4352AD99-9FF5-41A6-A319-068089******
PageNumber	integer	O número da página.	1
StartTime	string	O início do intervalo de tempo consultado.	2020-11-30T00:00Z
DBClusterId	string	O ID do cluster ao qual a tarefa pertence.	pc-***************

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "Tasks": {
    "Task": [
      {
        "FinishTime": "2020-12-02T02:40:15Z",
        "StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_task\\\",\\\"progress\\\":100},{\\\"remain\\\":1764,\\\"name\\\":\\\"create_instance\\\",\\\"progress\\\":0},{\\\"remain\\\":1,\\\"name\\\":\\\"init_cluster\\\",\\\"progress\\\":0},{\\\"remain\\\":2,\\\"name\\\":\\\"create_backup\\\",\\\"progress\\\":0}]",
        "Progress": 100,
        "ExpectedFinishTime": "null",
        "BeginTime": "2020-12-02T02:39:15Z",
        "TaskErrorCode": "null",
        "ProgressInfo": "null",
        "CurrentStepName": "create_instance",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "DBName": "test",
        "Remain": 1767,
        "TaskId": "111111111"
      }
    ]
  },
  "EndTime": "2020-12-02T03:00Z",
  "RequestId": "4352AD99-9FF5-41A6-A319-068089******",
  "PageNumber": 1,
  "StartTime": "2020-11-30T00:00Z",
  "DBClusterId": "pc-***************"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	InvalidStatus.Malformed	The specified parameter Status is not valid.	The specified Status 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.