DescribeBackupTasks - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

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

dds:DescribeBackupTasks

none

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-2zeb2d64cb46xxxx
BackupJobId	string	Não	O ID do trabalho de backup. Nota Se você chamar CreateBackup para realizar um backup manual, poderá passar o ID de backup retornado para consultar o progresso do backup.	170034

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>	Os detalhes dos trabalhos de backup.
	object	Os detalhes do trabalho de backup.
BackupjobId	string	O ID do trabalho de backup.	170034
BackupSetStatus	string	O status do trabalho de backup. Scheduled: O trabalho de backup está agendado. Isso inclui trabalhos de backup regulares que não foram iniciados. Checking: A instância está sendo verificada antes do backup. Backuping: O backup está em andamento. Finished: O backup foi concluído.	Scheduled
BackupStartTime	string	A hora de início do backup.	2024-01-16T11:04:56Z
Progress	string	O progresso do backup em porcentagem. O progresso é exibido apenas para trabalhos de backup em execução.	18%
JobMode	string	O modo de backup. Valores válidos: Automated: backup automático. Manual: backup manual.	Manual

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": "170034\n",
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

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.