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

Obtém os detalhes de todas as tarefas agendadas.

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

get

*DBCluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Status	string	Não	O status da tarefa. Valores válidos: pending: A tarefa está aguardando ser executada. executing: A tarefa está sendo executada. failure: A tarefa falhou e está aguardando uma nova tentativa. finish: A tarefa está concluída. cancel: A tarefa foi cancelada. expired: A tarefa expirou porque não foi iniciada dentro da janela de tempo agendada. rollback: A tarefa está sendo revertida. Nota Se este parâmetro for omitido, as tarefas agendadas em todos os estados serão consultadas.	finish
DBClusterId	string	Não	O ID do cluster. Nota Você pode chamar a operação DescribeDBClusters para consultar os detalhes de todos os clusters em uma região específica, incluindo os IDs dos clusters. Se este parâmetro for omitido, as tarefas agendadas para todos os clusters na sua conta serão consultadas.	pc-**************
RegionId	string	Não	O ID da região. Nota Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis. Se este parâmetro for omitido, as tarefas agendadas em todas as regiões da sua conta serão consultadas.	cn-hangzhou
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 (padrão), 50 e 100.	30
TaskAction	string	Não	A ação da tarefa agendada. Valores válidos: CreateDBNodes ModifyDBNodeClass UpgradeDBClusterVersion ModifyDBClusterPrimaryZone Nota Os detalhes da tarefa são retornados apenas se você especificar o parâmetro `PlannedStartTime` ao chamar uma das operações de API anteriores. Caso contrário, o campo `TimerInfos` na resposta estará vazio. Se este parâmetro for omitido, as tarefas agendadas de todos os tipos serão consultadas.	CreateDBNodes
DBClusterDescription	string	Não	A descrição do cluster.	testdb
OrderId	string	Não	O ID do pedido. Nota O ID do pedido pode conter apenas dígitos.	20951253014****
PlannedStartTime	string	Não	O horário de início mais cedo da tarefa. O horário está em UTC.	2021-01-28T12:00Z
PlannedEndTime	string	Não	O horário de início mais tardio da tarefa. O horário está em UTC. Se a tarefa não for iniciada até este horário, ela expirará.	2021-01-28T12:30Z
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Data	object	O conjunto de resultados.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	30
TimerInfos	array<object>	Detalhes das tarefas agendadas.
	object
Action	string	The task type.	CreateDBNodes
CrontabJobId	string	The ID of the scheduled O&M task.	86293c29-a03d-4872-b625-***********
DBClusterId	string	The cluster ID.	pc-**************
DbClusterDescription	string	The cluster description.	test_cluster
DbClusterStatus	string	The cluster status.	Running
OrderId	string	The order ID. Nota This parameter is returned only if `Action` is CreateDBNodes or ModifyDBNodeClass.	208161753******
PlannedEndTime	string	The latest start time of the task. The time is in UTC.	2021-01-28T12:30Z
PlannedFlashingOffTime	string	The scheduled time for the transient switchover.	2021-01-28T12:30Z
PlannedStartTime	string	The scheduled start time of the task. The time is in UTC.	2021-01-28T12:00Z
PlannedTime	string	The estimated start time of the task. The time is in UTC.	2021-01-28T12:16Z
Region	string	The region ID of the task.	cn-hangzhou
Status	string	The status of the task.	finish
TaskCancel	boolean	Indicates whether the scheduled task can be canceled. Valid values: true false	true
TaskId	string	The task ID.	53879cdb-9a00-428e-acaf-ff4cff******
TotalRecordCount	integer	O número total de entradas.	1
Message	string	A mensagem de resposta. Nota Se a solicitação for bem-sucedida, Successful será retornado. Caso contrário, uma mensagem de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	936C7025-27A5-4CB1-BB31-540E1F0CCA12
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TimerInfos": [
      {
        "Action": "CreateDBNodes",
        "CrontabJobId": "86293c29-a03d-4872-b625-***********",
        "DBClusterId": "pc-**************",
        "DbClusterDescription": "test_cluster",
        "DbClusterStatus": "Running",
        "OrderId": "208161753******",
        "PlannedEndTime": "2021-01-28T12:30Z",
        "PlannedFlashingOffTime": "2021-01-28T12:30Z",
        "PlannedStartTime": "2021-01-28T12:00Z",
        "PlannedTime": "2021-01-28T12:16Z",
        "Region": "cn-hangzhou",
        "Status": "finish",
        "TaskCancel": true,
        "TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
      }
    ],
    "TotalRecordCount": 1
  },
  "Message": "Successful",
  "RequestId": "936C7025-27A5-4CB1-BB31-540E1F0CCA12",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidOrderId.Malformed	The specified parameter OrderId is not valid.	The specified order ID is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.