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

Obtém uma lista de trabalhos de backup e seus detalhes para um cluster.

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

get

*dbcluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-***************
BackupJobId	string	Não	O ID do trabalho de backup.	11111111
BackupMode	string	Não	O modo de backup. Valores válidos: Automated: Um backup automático. Manual: Um backup manual.	Manual

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	FA8C1EF1-E3D4-44D7-B809-823187******
Items	object
BackupJob	array<object>	Os detalhes do trabalho de backup.
	object
StartTime	string	The time when the backup job started. The time is in Coordinated Universal Time (UTC) and the format is `YYYY-MM-DDThh:mm:ssZ`.	2020-08-08T07:24:01Z
Process	string	The progress of the backup job in percentage.	0
BackupJobId	string	The backup job ID.	11111111
JobMode	string	The backup mode. Valid values: Automated: An automatic backup. Manual: A manual backup.	Automated
BackupProgressStatus	string	The status of the backup job. Valid values: NoStart: The job has not started. Preparing: The job is being prepared. Waiting: The job is waiting. Uploading: The backup is being uploaded. Checking: The backup is being checked. Finished: The job is complete.	NoStart
TaskAction	string	The type of the backup job. Valid values: TempBackupTask: A temporary backup job. NormalBackupTask: A normal backup job.	NormalBackupTask

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FA8C1EF1-E3D4-44D7-B809-823187******",
  "Items": {
    "BackupJob": [
      {
        "StartTime": "2020-08-08T07:24:01Z",
        "Process": "0",
        "BackupJobId": "11111111",
        "JobMode": "Automated",
        "BackupProgressStatus": "NoStart",
        "TaskAction": "NormalBackupTask"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	The specified BackupMode 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.