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

Consulta a lista de backups de uma instância de cluster de banco de dados ApsaraDB for Tair (Redis® OSS-Compatible).

Descrição da operação

Esta operação aplica-se apenas a instâncias cloud-native.

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

get

*DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-zhangjiakou
InstanceId	string	Sim	O ID da instância.	r-t4nj72oug5r5646qog
ClusterBackupId	string	Não	O ID do conjunto de backups do cluster.	cb-hyxdof5x9kqbtust
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 5 : 5 entradas por página. 10 : 10 entradas por página. 15 : 15 entradas por página. 20 : 20 entradas por página. 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.	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.	2024-06-28T08:26Z
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.	2024-07-01T09:26Z
NoShardBackup	string	Não	Especifica se deve exibir os detalhes dos conjuntos de backups para os nós do cluster. Valores válidos: false (padrão): Exibe as informações do conjunto de backups dos nós do cluster. true: Não exibe as informações do conjunto de backups dos nós do cluster. Valores válidos: True : Não exibe os detalhes dos conjuntos de backups de shard. False : Exibe os detalhes dos conjuntos de backups de shard.	True

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	C009DA42-3B19-5B81-963D-1509DE2408DD
MaxResults	integer	O número máximo de entradas retornadas para a solicitação atual.	4
PageNumber	integer	O número da página, que é o mesmo que o parâmetro da solicitação.	1
PageSize	integer	O número máximo de entradas por página, que é o mesmo que o parâmetro da solicitação.	30
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 backups retornados na solicitação 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 backups na resposta à solicitação atual. Ele representa o tamanho total de todos os backups de log válidos da instância.	5000
FreeSize	integer	Este parâmetro não tem efeito. Ignore este parâmetro.	100000
ClusterBackups	array<object>	A lista de conjuntos de backups do cluster. Cada backup do cluster contém os conjuntos de backups de todos os nós.
	array<object>	A lista de conjuntos de backups do cluster. Cada backup do cluster contém os conjuntos de backups de todos os nós.
IsAvail	integer	Indica se o conjunto de backups do cluster é válido. O valor é 0 se os conjuntos de backups dos nós filhos estiverem incompletos ou com falha.	1
ClusterBackupId	string	O ID do conjunto de backups do cluster.	cb-zmdqj2m3xyxjtdt0
ClusterBackupStatus	string	O status do conjunto de backups do cluster. Valores válidos: OK: Bem-sucedido. RUNNING: Em execução. Outros valores: Falha.	OK
ClusterBackupSize	string	O tamanho do conjunto de backups do cluster.	2048
ClusterBackupStartTime	string	A hora de início do backup do cluster. A hora está no formato YYYY-MM-DDTHH:mm:ssZ e é exibida em UTC.	2024-01-10T17:21:25Z
ClusterBackupEndTime	string	A hora de término do backup do cluster. A hora está no formato YYYY-MM-DDTHH:mm:ssZ e é exibida em UTC.	2024-01-10T17:21:55Z
ClusterBackupMode	string	O modo de backup do cluster.	Automated
ShardClassMemory	integer	O tamanho da especificação de memória de um único nó de banco de dados quando o backup completo foi criado. Unidade: MB.	1024
Backups	array<object>	A coleção de conjuntos de backups para todos os nós filhos sob um único conjunto de backups do cluster.
	array<object>	Os detalhes do conjunto de backups.
BackupId	string	O ID do arquivo de backup.	514645788
InstanceName	string	O nome da instância.	r-bp1y4is8svonly****-db-0
BackupDownloadURL	string	A URL de download pública do arquivo de backup.	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
BackupIntranetDownloadURL	string	A URL de download interna do arquivo de backup. Nota Você pode usar esta URL para baixar o arquivo de backup em uma instância ECS que esteja conectada à instância atual. Ambas as instâncias devem pertencer à mesma VPC.	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
RecoverConfigMode	string	Este parâmetro não tem efeito. Ignore este parâmetro.	null
BackupStartTime	string	A hora de início do backup. A hora está no formato yyyy-MM-ddTHH:mm:ssZ e é exibida em UTC.	2024-01-09T17:21:30Z
BackupEndTime	string	A hora de término do backup. A hora está no formato yyyy-MM-ddTHH:mm:ssZ e é exibida em UTC.	2024-01-09T17:21:57
BackupSize	string	O tamanho do arquivo de backup. Unidade: bytes.	1024
IsAvail	string	Indica se o conjunto de backups está disponível. Valores válidos: 0: Indisponível. 1: Disponível.	1
BackupStatus	string	O status do backup. Valores válidos: OK: Bem-sucedido. ERROR: Falha.	OK
BackupName	string	O nome do backup.	hins100322105_data_20240110012135.rdb
Engine	string	O tipo de mecanismo de banco de dados. O valor é fixo como redis.	redis
ExtraInfo	object	As informações adicionais.
CustinsDbVersion	string	A versão do mecanismo de banco de dados.	5.0
Progress	string	O progresso do backup. Este parâmetro é exibido apenas para backups que estão em andamento.	100%
ExpectExpireTime	string	A hora de expiração do conjunto de backups. A hora está no formato yyyy-MM-ddTHH:mmZ e é exibida em UTC.	2025-06-01T21:51:22Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
  "MaxResults": 4,
  "PageNumber": 1,
  "PageSize": 30,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
      "ClusterBackupStatus": "OK",
      "ClusterBackupSize": "2048",
      "ClusterBackupStartTime": "2024-01-10T17:21:25Z",
      "ClusterBackupEndTime": "2024-01-10T17:21:55Z",
      "ClusterBackupMode": "Automated",
      "ShardClassMemory": 1024,
      "Backups": [
        {
          "BackupId": "514645788",
          "InstanceName": "r-bp1y4is8svonly****-db-0",
          "BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "RecoverConfigMode": "null",
          "BackupStartTime": "2024-01-09T17:21:30Z",
          "BackupEndTime": "2024-01-09T17:21:57",
          "BackupSize": "1024",
          "IsAvail": "1",
          "BackupStatus": "OK",
          "BackupName": "hins100322105_data_20240110012135.rdb",
          "Engine": "redis",
          "ExtraInfo": {
            "CustinsDbVersion": "5.0"
          }
        }
      ],
      "Progress": "100%",
      "ExpectExpireTime": "2025-06-01T21:51:22Z"
    }
  ]
}

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.