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

Consulta o status de uma tarefa em lote.

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

none

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BatchId	string	Não	O ID da tarefa em lote.	pcb-xxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB
BatchId	string	O ID da tarefa em lote.	pcb-xxx
TaskName	string	O nome da tarefa.	batch_task_test
TaskType	string	O tipo da tarefa.	polarclaw_install_skills
Status	string	O status da tarefa. Valores válidos: COMPLETED : A tarefa foi concluída. DISPATCHING : A tarefa está sendo despachada. FAILED : A tarefa falhou. [_single.resp.200.props.Status.enum.RUNNING ]A tarefa está em execução. [responses.200.schema.properties.Status.enumValueTitles.RUNNING ]A tarefa está em execução. RUNNING : The task is running.	RUNNING
TotalCount	integer	O número total de subtarefas.	10
SuccessCount	integer	O número de subtarefas bem-sucedidas.	8
TaskBegin	string	A hora em que a tarefa foi iniciada.	2026/05/28T16:38:20Z
TaskEnd	string	A hora em que a tarefa foi encerrada.	2026/05/28T15:23:47Z
SubTasks	array<object>	Uma lista de subtarefas.
	object	Uma subtarefa.
TaskId	string	O ID da subtarefa.	629271331
InstanceId	string	O ID da instância.	pc-pz5f6mvi1p84t35d7
Status	string	O status da subtarefa. [_single.resp.200.props.SubTasks.items.Status.enum.COMPLETED ]A subtarefa foi concluída. [responses.200.schema.properties.SubTasks.items.properties.Status.enumValueTitles.COMPLETED ]A subtarefa foi concluída. Valores válidos: COMPLETED : The subtask is completed. FAILED : A subtarefa falhou. [_single.resp.200.props.SubTasks.items.Status.enum.PAUSE ]A subtarefa está pausada. [responses.200.schema.properties.SubTasks.items.properties.Status.enumValueTitles.PAUSE ]A subtarefa está pausada. PAUSE : The subtask is paused. RUNNING : A subtarefa está em execução. TEMP_TERMINATED : A subtarefa foi temporariamente encerrada. WAITING : A subtarefa está aguardando execução. HUMAN_PROCESSING : A subtarefa está sendo processada manualmente. BLOCKING : A subtarefa está bloqueada.	COMPLETED
TaskBegin	string	A hora em que a subtarefa foi iniciada.	2026/05/28T17:38:20Z
TaskEnd	string	A hora em que a subtarefa foi encerrada.	2026/05/28T20:38:20Z
ErrorMsg	string	A mensagem de erro.	aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole
ApplicationType	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB",
  "BatchId": "pcb-xxx",
  "TaskName": "batch_task_test",
  "TaskType": "polarclaw_install_skills",
  "Status": "RUNNING ",
  "TotalCount": 10,
  "SuccessCount": 8,
  "TaskBegin": "2026/05/28T16:38:20Z",
  "TaskEnd": "2026/05/28T15:23:47Z",
  "SubTasks": [
    {
      "TaskId": "629271331",
      "InstanceId": "pc-pz5f6mvi1p84t35d7",
      "Status": "COMPLETED",
      "TaskBegin": "2026/05/28T17:38:20Z",
      "TaskEnd": "2026/05/28T20:38:20Z",
      "ErrorMsg": "aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole"
    }
  ],
  "ApplicationType": ""
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.