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

Consulta as informações sobre os conjuntos de backup em um cluster PolarDB liberado.

Descrição da operação

Antes de chamar esta operação, certifique-se de que o cluster PolarDB está no estado Released. Você também deve confirmar que a política de retenção de backup Retain All Backups Permanently ou Retain Last Automatic Backup Permanently está em vigor após a liberação do cluster. Se você excluir todos os conjuntos de backup após a liberação do cluster, não será possível usar esta operação de API para consultar o cluster.

Nota

Você pode chamar a operação DescribeDBClusterAttribute para consultar o status do 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:DescribeDetachedBackups

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-****************
BackupId	string	Não	O ID do conjunto de backup.	111111111
BackupStatus	string	Não	O status do conjunto de backup. Valores válidos: Success Failed	Success
BackupMode	string	Não	O modo de backup. Valores válidos: Automated Manual	Manual
BackupRegion	string	Não	A região onde o arquivo de backup de dados entre regiões da instância está armazenado. Nota Este parâmetro é válido apenas para clusters PolarDB for MySQL.	cn-hangzhou
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-05-01T00:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique o horário no formato `YYYY-MM-DDThh:mmZ`. O horário deve estar em UTC. O horário de término deve ser posterior ao horário de início.	2020-05-14T00:00Z
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 50 100 Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro positivo 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	string	O número total de entradas retornadas.	50
PageRecordCount	string	O número de entradas por página.	15
RequestId	string	O ID da solicitação.	717B2382-BB14-4DCB-BBC2-32DBE0******
PageNumber	string	O número da página.	1
Items	object
Backup	array<object>	Detalhes sobre os conjuntos de backup.
	object
BackupSetSize	string	The size of the backup set. Unit: bytes. Nota After you delete the target snapshot backups, the storage space consumed by the backups is released. The released storage space is smaller than the size of the backup file, because the snapshots share certain data blocks.	7251056
ConsistentTime	string	The snapshot checkpoint time. The value is a Unix timestamp.	1589253947
StoreStatus	string	Indicates whether the backup set can be deleted. Valid values: Enabled: The backup set can be deleted. Disabled: The backup set cannot be deleted.	Disabled
BackupStatus	string	The status of the backup set. Valid values: Success Failed	Success
BackupType	string	The type of the backup. Only full backups are supported. The value is set to FullBackup.	FullBackup
BackupStartTime	string	The start time of the backup task. The time is displayed in UTC.	2020-05-12T03:25:44Z
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: The data backup set is unavailable. 1: The data backup set is available.	1
BackupEndTime	string	The end time of the backup task. The time is displayed in UTC.	2020-05-12T03:25:55Z
BackupId	string	The ID of the backup set.	111111111
DBClusterId	string	The ID of the cluster.	pc-**************
BackupsLevel	string	The level of the backup set. Valid values: Level-1: level-1 backup set Level-2: level-2 backup set	Level-2
BackupMode	string	The backup mode. Valid values: Automated Manual	Manual
BackupMethod	string	The backup method. Only snapshot backups are supported. The value is set to Snapshot.	Snapshot

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": "50",
  "PageRecordCount": "15",
  "RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "7251056",
        "ConsistentTime": "1589253947",
        "StoreStatus": "Disabled",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-05-12T03:25:44Z",
        "IsAvail": "1",
        "BackupEndTime": "2020-05-12T03:25:55Z",
        "BackupId": "111111111",
        "DBClusterId": "pc-**************",
        "BackupsLevel": "Level-2",
        "BackupMode": "Manual",
        "BackupMethod": "Snapshot"
      }
    ]
  }
}

Códigos de erro

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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.