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

Consulta a lista de backups de uma instância de cluster do Tair (compatível com Redis OSS).

Descrição da operação

Esta API é aplicável apenas a instâncias nativas da nuvem.

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 a lista de regiões mais recente.	cn-zhangjiakou
InstanceId	string	Sim	O ID da instância.	r-t4nj72oug5r5646qog
ClusterBackupId	string	Não	O ID do conjunto de backups.	cb-hyxdof5x9kqbtust
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 50 100 200 300 5 10 15 20	30
PageNumber	integer	Não	O número da página.	1
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.	2024-06-28T08:26Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC. A hora de término deve ser posterior à hora de início.	2024-07-01T09:26Z
NoShardBackup	string	Não	Especifica se devem ser exibidas as informações do conjunto de backups para os shards na instância. true: não exibe as informações do conjunto de backups para os shards na instância. false (padrão): exibe as informações do conjunto de backups para os shards na instância. Valores válidos: True False	True

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	C009DA42-3B19-5B81-963D-1509DE2408DD
MaxResults	integer	O número máximo de entradas retornadas.	4
PageNumber	integer	O número da página.	1
PageSize	integer	O número máximo de entradas retornadas por página.	30
FullStorageSize	integer	O tamanho do arquivo de backup completo da instância. Unidade: bytes. Os backups completos são originados de backups agendados, backups manuais e backups gerados durante a análise de cache. Nota O valor deste parâmetro é independente do número e do tamanho dos conjuntos de backups retornados. Em vez disso, representa o tamanho de todos os backups completos válidos da instância.	1000
LogStorageSize	integer	O tamanho do arquivo de backup de log da instância. Unidade: bytes. Este parâmetro é válido apenas quando o flashback está ativado. Nota O valor deste parâmetro é independente do número e do tamanho dos conjuntos de backups retornados. Em vez disso, representa o tamanho 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>	Os conjuntos de backups da instância. Um backup contém os conjuntos de backups de todos os shards na instância.
	array<object>	O conjunto de backups da instância. Um backup contém os conjuntos de backups de todos os shards na instância.
IsAvail	integer	Indica se o conjunto de backups é válido. Um valor 0 indica que os backups no nível do shard falharam ou não foram concluídos.	1
ClusterBackupId	string	O ID do conjunto de backups.	cb-zmdqj2m3xyxjtdt0
ClusterBackupStatus	string	O status do conjunto de backups. OK RUNNING Failed	OK
ClusterBackupSize	string	O tamanho do conjunto de backups.	2048
ClusterBackupStartTime	string	A hora de início do backup.	2024-01-10T17:21:25Z
ClusterBackupEndTime	string	A hora de término do backup.	2024-01-10T17:21:55Z
ClusterBackupMode	string	O modo de backup.	Automated
ShardClassMemory	integer	O tamanho da memória de um único shard durante um backup completo. Unidade: MB.	1024
Backups	array<object>	Os conjuntos de backups de todos os shards na instância.
	array<object>	O conjunto de backups consultado.
BackupId	string	The ID of the backup file.	514645788
InstanceName	string	The instance name.	r-bp1y4is8svonly****-db-0
BackupDownloadURL	string	The public download URL of the backup file.	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
BackupIntranetDownloadURL	string	The internal download URL of the backup file. Nota You can use this URL to download the backup file from an Elastic Compute Service (ECS) instance that is connected to the Tair (Redis OSS-compatible) instance. The ECS instance must reside in the same virtual private cloud (VPC) as the Tair (Redis OSS-compatible) instance.	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
RecoverConfigMode	string	This parameter does not take effect. Ignore this parameter.	null
BackupStartTime	string	The start time of the backup. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-01-09T17:21:30Z
BackupEndTime	string	The end time of the backup. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-01-09T17:21:57
BackupSize	string	The size of the backup file. Unit: bytes.	1024
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: unavailable 1: available	1
BackupStatus	string	The status of the backup. Valid values: OK ERROR	OK
BackupName	string	The name of the backup.	hins100322105_data_20240110012135.rdb
Engine	string	The database engine. The return value is redis.	redis
ExtraInfo	object	The additional information.
CustinsDbVersion	string	The engine version.	5.0
Progress	string	O progresso do backup. O sistema exibe apenas o progresso das tarefas de backup em execução.	100%
ExpectExpireTime	string	O tempo de vida (TTL) do conjunto de backups, no formato aaaa-MM-ddTHH:mmZ (hora 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.