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

Consulta as informações de backup de um cluster PolarDB.

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

get

*Backup

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

*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 backup.	11111111
BackupStatus	string	Não	O status do backup. Valores válidos: Success: O backup foi concluído. Failed: O backup falhou.	Success
BackupMode	string	Não	O modo de backup. Valores válidos: Automated: backup automático Manual: backup manual	Automated
StartTime	string	Sim	A hora de início da consulta. A hora está no formato `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-14T00:00Z
EndTime	string	Sim	A hora de término da consulta. A hora de término deve ser posterior à hora de início. A hora está no formato `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-16T00:00Z
BackupRegion	string	Não	A região de destino para backups entre regiões. Nota Este parâmetro é suportado apenas pelo PolarDB for MySQL.	cn-hangzhou
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 Integer. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	string	O número total de entradas.	1
PageRecordCount	string	O número de entradas na página atual.	1
RequestId	string	O ID da solicitação.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	O número da página.	1
Items	object
Backup	array<object>	Os detalhes dos conjuntos de backup.
	object
BackupSetSize	string	O tamanho do arquivo de backup. Unidade: bytes. Nota Como os blocos de dados são compartilhados entre snapshots, o espaço liberado após a exclusão de um backup de snapshot é muito menor que o tamanho do arquivo de backup. Para obter mais informações, consulte Perguntas frequentes sobre backup.	4639948800
ConsistentTime	string	O ponto no tempo do snapshot consistente. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1605425407
BackupStatus	string	O status do backup. Valores válidos: Success: O backup foi concluído. Failed: O backup falhou.	Success
BackupType	string	O tipo de backup. Apenas backups completos são suportados. O valor é fixo como FullBackup.	FullBackup
BackupStartTime	string	A hora de início do backup (UTC).	2020-11-15T07:30:05Z
ExpectExpireTime	string	A hora de expiração esperada do conjunto de backup. Este parâmetro é suportado apenas para instâncias que têm o recurso de backup esparso ativado. A hora está no formato `YYYY-MM-DDTHH:mm:ssZ` (UTC).	2022-10-24T08:13:23Z
ExpectExpireType	string	O tipo de expiração esperada do conjunto de backup. Este parâmetro é suportado apenas para instâncias que têm o recurso de backup esparso ativado. Valores válidos: NEVER : NEVER. EXPIRED : EXPIRED. DELAY : DELAY.	EXPIRED
IsAvail	string	Indica se o conjunto de backup está disponível. Valores válidos: 0: indisponível 1: disponível	0
BackupEndTime	string	A hora de término do backup (UTC).	2020-11-15T07:30:20Z
BackupId	string	O ID do backup.	61*******
DBClusterId	string	O ID do cluster.	pc-****************
BackupsLevel	string	O nível do conjunto de backup. Valores válidos: Level-1: backup de nível 1 Level-2: backup de nível 2	Level-1
BackupMode	string	O modo de backup. Valores válidos: Automated: backup automático Manual: backup manual	Automated
BackupMethod	string	O método de backup de dados. Apenas backups de snapshot são suportados. O valor é fixo como Snapshot.	Snapshot
TableRestoreMetaStatus	string	Indica se a restauração de banco de dados e tabelas é suportada.
Comment	string	O comentário sobre o conjunto de backup.	manual-backup
TotalLevel2BackupSize	string	O tamanho total dos backups de nível 2 na região especificada. Unidade: bytes. Nota Apenas os tipos de armazenamento PSL4 e PSL5 são suportados. Apenas clusters que têm o recurso de backup de nível 2 ativado são suportados. Se este parâmetro não for retornado, o tamanho dos backups de nível 2 será 0.	4639948800

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot",
        "TableRestoreMetaStatus": "",
        "Comment": "manual-backup"
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

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.	O parâmetro BackupStatus especificado é inválido.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	O parâmetro BackupMode especificado é inválido.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	O parâmetro StartTime especificado é inválido.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	O parâmetro EndTime especificado é inválido.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	O parâmetro PageSize especificado é inválido.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	O parâmetro PageNumber especificado é inválido.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	A operação falhou. O ID da instância do cluster especificado não existe.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	O DBClusterId especificado não existe nos registros atuais.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.