DescribeBackups - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta as informações do arquivo de backup de uma instância de banco de dados ApsaraDB for Tair (compatível com Redis).

Descrição da operação

Esta operação não se aplica a instâncias de arquitetura de cluster nativas da nuvem. Para consultar os conjuntos de backup dessas instâncias, use a operação DescribeClusterBackupList.

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

kvstore:DescribeBackups

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	r-bp1zxszhcgatnx****
BackupId	integer	Não	O ID do arquivo de backup.	11611111
BackupJobId	integer	Não	O ID da tarefa de backup. Este ID é retornado pela operação CreateBackup. Se a operação CreateBackup retornar vários BackupJobIds, você deve chamar esta operação para consultar cada um deles separadamente.	10001
PageSize	integer	Não	O número máximo de entradas por página. Valores válidos: 30, 50, 100, 200 e 300. Valores válidos: 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página. 200 : 200 entradas por página. 300 : 300 entradas por página.	30
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
StartTime	string	Sim	A hora de início da consulta. Especifique a hora no formato yyyy-MM-ddTHH:mmZ. A hora deve estar em UTC.	2019-03-11T10:00Z
EndTime	string	Sim	A hora de término da consulta. A hora de término deve ser posterior à hora de início. Especifique a hora no formato yyyy-MM-ddTHH:mmZ. A hora deve estar em UTC.	2019-03-14T18:00Z
NeedAof	string	Não	Especifica se a persistência AOF deve ser ativada. Valores válidos: 0: desativada. 1: ativada. Nota Valor padrão: 0.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	O número da página.	1
PageSize	integer	O número máximo de entradas por página.	30
TotalCount	integer	O número total de conjuntos de backup.	5
FullStorageSize	integer	O tamanho dos arquivos de backup completo da instância atual. Unidade: bytes. Os backups completos incluem backups agendados diariamente, backups manuais e backups gerados durante a análise de cache. Nota Este valor é independente do número e do tamanho dos conjuntos de backup retornados na resposta atual. Ele representa o tamanho total de todos os backups completos válidos da instância.	1000
LogStorageSize	integer	O tamanho dos arquivos de backup de log da instância atual. Unidade: bytes. Este valor é válido apenas quando o recurso flashback está ativado. Nota Este valor é independente do número e do tamanho dos conjuntos de backup retornados na resposta atual. Ele representa o tamanho total de todos os backups de log válidos da instância.	5000
FreeSize	integer	Este parâmetro é inválido. Ignore este parâmetro.	100000
Backups	object
Backup	array<object>	Os detalhes dos conjuntos de backup.
	object	Os detalhes dos conjuntos de backup.
BackupStatus	string	O status do backup. Valores válidos: Success: bem-sucedido. Failed: com falha.	Success
BackupStartTime	string	A hora de início do backup. A hora está no formato YYYY-MM-DDTHH:mm:ssZ e é exibida em UTC.	2019-03-14T05:28:50Z
BackupType	string	O tipo de backup. Valores válidos: FullBackup: backup completo. IncrementalBackup: backup incremental.	FullBackup
BackupDownloadURL	string	A URL de download pública do arquivo de backup.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	O ID do nó. Nota Se a instância usar a arquitetura padrão, este parâmetro retornará o ID da instância.	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	A hora de término do backup. A hora está no formato YYYY-MM-DDTHH:mm:ssZ e é exibida em UTC.	2019-03-14T05:31:13Z
BackupId	integer	O ID do arquivo de backup.	165*****50
BackupDBNames	string	Os bancos de dados incluídos no backup. Valor padrão: all, que indica que todos os bancos de dados estão incluídos no backup.	all
EngineVersion	string	A versão do mecanismo DPI, que é a versão compatível com Redis da instância.	4.0
BackupIntranetDownloadURL	string	A URL de download interna do arquivo de backup. Nota Você pode usar esta URL para baixar o arquivo de backup de uma instância ECS que esteja conectada à instância Tair. Ambas as instâncias devem residir na mesma VPC.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	integer	O tamanho do arquivo de backup.	1024
BackupMode	string	O modo de backup. Valores válidos: Automated: backup automático. Manual: backup manual.	Automated
BackupMethod	string	O método de backup. Valores válidos: Logical: backup lógico. Physical: backup físico.	Physical
BackupJobID	integer	O ID da tarefa de backup.	24340
RecoverConfigMode	string	Especifica se o conjunto de backup contém informações de conta, parâmetro de kernel (config) e lista de permissões. O valor retornado é uma string de caracteres JSON, como {"whitelist":true,"config":true,"account":true}. Nota Este parâmetro se aplica apenas a instâncias nativas da nuvem. Se você modificar as informações anteriores da instância, como criar uma conta ou adicionar uma lista de permissões, as informações modificadas serão incluídas nos conjuntos de backup automático subsequentes.	{"whitelist":true,"config":true,"account":true}
ExpectExpireTime	string	A hora de expiração do conjunto de backup. A hora está no formato yyyy-MM-ddTHH:mmZ e é exibida em UTC.	2025-06-01T21:51:22Z
AccessDeniedDetail	object	Estes parâmetros estão obsoletos. Ignore-os.
AuthAction	string	Consulte a descrição anterior.	-
AuthPrincipalDisplayName	string	Consulte a descrição anterior.	-
AuthPrincipalOwnerId	string	Consulte a descrição anterior.	-
AuthPrincipalType	string	Consulte a descrição anterior.	-
EncodedDiagnosticMessage	string	Consulte a descrição anterior.	-
NoPermissionType	string	Consulte a descrição anterior.	-
PolicyType	string	Consulte a descrição anterior.	-

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidEngineVersion.Malformed	The Specified EngieVersion is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.	A hora de término deve ser posterior à hora de início.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.