DescribeBackupDataList - Data Management: Central de Documentação do Alibaba Cloud

Consulta dados de backup de um cluster PolarDB for MySQL.

Descrição da operação

Mecanismos aplicáveis

PolarDB for MySQL

Nota

Esta operação de API está disponível apenas para clientes específicos. Para usar esta operação, entre no grupo DingTalk do Serviço ao Cliente DBS (ID: 35585947) para solicitar acesso.

Documentos relacionados

Fazer backup de um cluster PolarDB for MySQL

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

dbs:DescribeBackupDataList

list

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceName	string	Não	O ID do cluster PolarDB.	pc-2ze3nrr64c5******
RegionCode	string	Não	A região onde o conjunto de backup está localizado.	cn-hangzhou
SceneType	string	Não	O cenário de backup. Este parâmetro suporta apenas LEVEL_1, que indica um backup de nível 1 na região onde a instância reside.	LEVEL_1
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2024-04-17T17:00:16Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2024-04-17T17:00:32Z
BackupStatus	string	Não	O status do conjunto de backup. Valores válidos: OK: O backup foi bem-sucedido. ERROR: O backup falhou.	OK
BackupId	string	Não	O ID do conjunto de backup.	213064****
BackupMethod	string	Não	O método de backup. Valores válidos: Physical: backup físico Logical: backup lógico Snapshot: backup de snapshot	Snapshot
BackupMode	string	Não	O modo de backup. Valores válidos: Automated: backup automático Manual: backup manual	Automated
BackupType	string	Não	O tipo de backup. Valores válidos: FullBackup: backup completo IncrementBackup: backup incremental	FullBackup
BackupScale	string	Não	O escopo do backup. Valores válidos: DBInstance: backup de instância DBTable: backup de banco de dados e tabela	DBInstance
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. O valor padrão é 20.	20
PageNumber	integer	Não	O número da página. O valor deve ser um inteiro maior que 0 e que não exceda o valor máximo do tipo de dados inteiro. O valor padrão é 1.	1
InstanceIsDeleted	boolean	Não	Especifica se a instância foi excluída. Valores válidos: true: A instância foi excluída. false: A instância não foi excluída. Este é o valor padrão.	false
InstanceRegion	string	Não	A região original da instância.	cn-hangzhou
DataSourceId	string	Não	Este parâmetro é reservado e não precisa ser especificado.	test****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes dos parâmetros retornados.
Data	object	Os dados retornados.
Content	array<object>	Os detalhes da tarefa.
	array<object>	Os detalhes da tarefa.
BackupId	string	The ID of the backup set.	213088****
BackupName	string	The name of the backup set.	logic_backup
BackupMode	string	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	Automated
BackupType	string	The backup type. Valid values: FullBackup: full backup IncrementBackup: incremental backup	FullBackup
BackupScale	string	The backup scope. Valid values: DBInstance: instance backup DBTable: database and table backup	DBInstance
BackupMethod	string	The backup method. Valid values: Physical: physical backup Logical: logical backup Snapshot: snapshot backup	Snapshot
BackupSize	integer	The size of the backup set in bytes.	25669140480
BackupStatus	string	The status of the backup set. Valid values: OK: The backup is successful. ERROR: The backup failed.	OK
BackupStartTime	string	The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-17T17:00:16Z
BackupEndTime	string	The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-17T17:00:32Z
ConsistentTime	integer	The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.	1713373221
BackupLocation	string	The storage path of the backup.	logic
InstanceName	string	The ID of the instance.	pc-2ze3nrr64c5******
Engine	string	The database engine type.	polardb_mysql
EngineVersion	string	The database engine version.	5.7
SupportDeletion	integer	Indicates whether the backup set can be deleted. Valid values: 0: The backup set can be deleted. 1: The backup set cannot be deleted.	0
Encryption	string	The encryption information.	psk2
IsAvail	integer	Indicates whether the backup set is available. Valid values: 1: The backup set is available. 0: The backup set is unavailable.	1
Checksum	string	The checksum.	84a4c16431f969712e6895992719****
BackupDownloadURL	string	The public download URL of the backup set. Nota This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
BackupIntranetDownloadURL	string	The internal download URL of the backup set. Nota This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
ExpectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PolarSnapshot	object	The information about the level-2 dump of the PolarDB cluster. Nota The PolarSnapshot-related information is returned only after the level-2 dump feature is enabled for the PolarDB cluster in the same region and the level-1 backup is successfully dumped.
DumpId	integer	The ID of the dump.	abc****
DumpSize	integer	The size of the dump backup in bytes.	25669140589
expectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PageSize	integer	O tamanho da página.	20
PageNumber	integer	O número da página.	1
TotalPages	integer	O número total de páginas.	1
TotalElements	integer	O número total de conjuntos de backup.	1
Extra	string	Informações extras.	dbtest
RequestId	string	O ID da solicitação.	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	O código de erro.	Request.Forbidden
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
ErrMessage	string	A mensagem de erro.	The specified parameter %s value is not valid.
Code	string	O código de status.	Success
Message	string	A mensagem retornada.	The specified parameter %s value is not valid.

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "Content": [
      {
        "BackupId": "213088****",
        "BackupName": "logic_backup",
        "BackupMode": "Automated",
        "BackupType": "FullBackup",
        "BackupScale": "DBInstance",
        "BackupMethod": "Snapshot",
        "BackupSize": 25669140480,
        "BackupStatus": "OK",
        "BackupStartTime": "2024-04-17T17:00:16Z",
        "BackupEndTime": "2024-04-17T17:00:32Z",
        "ConsistentTime": 1713373221,
        "BackupLocation": "logic",
        "InstanceName": "pc-2ze3nrr64c5******",
        "Engine": "polardb_mysql",
        "EngineVersion": "5.7",
        "SupportDeletion": 0,
        "Encryption": "psk2",
        "IsAvail": 1,
        "Checksum": "84a4c16431f969712e6895992719****",
        "BackupDownloadURL": "http://oss.com/****",
        "BackupIntranetDownloadURL": "http://oss.com/****",
        "ExpectExpireType": "DELAY",
        "ExpectExpireTime": "2024-04-19T05:00:49Z",
        "PolarSnapshot": {
          "DumpId": 0,
          "DumpSize": 25669140589,
          "expectExpireType": "DELAY",
          "ExpectExpireTime": "2024-04-19T05:00:49Z"
        }
      }
    ],
    "PageSize": 20,
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalElements": 1,
    "Extra": "dbtest"
  },
  "RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
  "ErrCode": "Request.Forbidden\t",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Request.Forbidden	Have no Permissions

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.