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

Consulta informações sobre arquivos de backup para uma instância do ApsaraDB for Tair compatível com Redis.

Descrição da operação

Esta operação não se aplica a instâncias de cluster nativas da nuvem. Em vez disso, 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 do job de backup retornado pela operação CreateBackup. Se CreateBackup retornar vários IDs de job de backup, chame esta operação para cada ID.	10001
PageSize	integer	Não	O número máximo de entradas a serem retornadas por página. Valores válidos: 30, 50, 100, 200 e 300.	30
PageNumber	integer	Não	O número da página a ser retornado. O valor deve ser maior que 0. O valor padrão é 1.	1
StartTime	string	Sim	A hora de início da consulta. Especifique a hora em UTC usando o formato yyyy-MM-ddTHH:mmZ.	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 em UTC usando o formato yyyy-MM-ddTHH:mmZ.	2019-03-14T18:00Z
NeedAof	string	Não	Especifica se a persistência AOF deve ser ativada. Valores válidos: 0: Desativado. 1: Ativado. Nota O valor padrão é 0.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
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 de entradas por página.	30
TotalCount	integer	O número total de conjuntos de backup.	5
FullStorageSize	integer	O tamanho total dos backups completos para a instância, em bytes. Os backups completos são gerados a partir de backups diários agendados, backups manuais ou análise de cache. Nota Este valor representa o tamanho total de todos os backups completos válidos para a instância, independentemente dos conjuntos de backup retornados nesta solicitação.	1000
LogStorageSize	integer	O tamanho total dos backups de log para a instância, em bytes. Este parâmetro é retornado apenas se o flashback estiver ativado. Nota Este valor representa o tamanho total de todos os backups de log válidos para a instância, independentemente dos conjuntos de backup retornados nesta solicitação.	5000
FreeSize	integer	Este parâmetro não está em vigor. Ignore este parâmetro.	100000
Backups	object	Detalhes sobre os conjuntos de backup.
Backup	array<object>	Um array de conjuntos de backup.
	object	Os detalhes de um conjunto de backup.
BackupStatus	string	The backup status. Valid values: Success: The backup was successful. Failed: The backup failed.	Success
BackupStartTime	string	The start time of the backup.	2019-03-14T05:28:50Z
BackupType	string	The backup type. Valid values: FullBackup: A full backup. IncrementalBackup: An incremental backup.	FullBackup
BackupDownloadURL	string	The public download URL of the backup set.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	The node ID. Nota For a Standard Edition instance, this parameter returns the instance ID.	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	The completion time of the backup.	2019-03-14T05:31:13Z
BackupId	integer	The ID of the backup set.	165*****50
BackupDBNames	string	The backed-up databases. A value of all indicates that all databases were backed up.	all
EngineVersion	string	The engine version of the instance. It specifies the compatible Redis version.	4.0
BackupIntranetDownloadURL	string	The internal download URL of the backup set. Nota You can use this URL to download the backup set from an ECS instance that is in the same VPC as the database instance.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	integer	The size of the backup set, in bytes.	1024
BackupMode	string	The backup mode. Valid values: Automated: An automated backup. Manual: A manual backup.	Automated
BackupMethod	string	The backup method. Valid values: Logical: A logical backup. Physical: A physical backup.	Physical
BackupJobID	integer	The ID of the backup job.	24340
RecoverConfigMode	string	Indicates whether the backup set includes configuration information such as accounts (`account`), kernel parameters (`config`), and allowlists (`whitelist`). Nota This parameter is available only for Cloud Native Edition instances. If you modify these settings, for example, create an account or add an IP address to an allowlist, the updated information is automatically included in subsequent backup sets.	{"whitelist":true,"config":true,"account":true}
ExpectExpireTime	string	The expiration time of the backup set. The time is in UTC and uses the yyyy-MM-ddTHH:mm:ssZ format.	2025-06-01T21:51:22Z
AccessDeniedDetail	object	Este parâmetro foi descontinuado.
AuthAction	string	Este parâmetro foi descontinuado.	-
AuthPrincipalDisplayName	string	Este parâmetro foi descontinuado.	-
AuthPrincipalOwnerId	string	Este parâmetro foi descontinuado.	-
AuthPrincipalType	string	Este parâmetro foi descontinuado.	-
EncodedDiagnosticMessage	string	Este parâmetro foi descontinuado.	-
NoPermissionType	string	Este parâmetro foi descontinuado.	-
PolicyType	string	Este parâmetro foi descontinuado.	-

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.	The end time must be later than the start time.
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.