ListBackupData - Hologres: Central de Documentação do Alibaba Cloud

Obtém uma lista de snapshots. Cada snapshot representa um backup point-in-time que pode ser usado para restaurar uma nova instância com seus dados completos.

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

hologram:ListBackupData

list

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Sintaxe da solicitação

GET /api/v1/backups HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Não	O ID da instância.	hgprecn-cn-wwoxxxxx
backupType	string	Não	O tipo de backup, usado para filtrar snapshots. Se você deixar este parâmetro vazio, todos os snapshots serão retornados. Valores válidos: redundant_remote : Armazena snapshots da instância entre zonas em uma região diferente. remote : É um filtro para snapshots remotos, não um tipo de backup. redundant : Armazena snapshots da instância entre zonas dentro da mesma região. full_remote : Armazena um snapshot da instância remotamente. local : É um filtro para snapshots locais, não um tipo de backup. full : Armazena um snapshot da instância localmente.	redundant

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46
BackupDataList	array<object>	A lista de backups.
	object
BackupType	string	O tipo de backup. redundant: Armazena snapshots da instância entre zonas dentro da mesma região. redundant_remote: Armazena snapshots da instância entre zonas em uma região diferente. full: Armazena um snapshot da instância localmente. full_remote: Armazena um snapshot da instância remotamente. local: É um filtro para snapshots locais, não um tipo de backup. remote: É um filtro para snapshots remotos, não um tipo de backup.	redundant
DataGran	string	A granularidade do backup. Valores válidos: instance : Nível de instância.	instance
Id	integer	O ID exclusivo do snapshot.	1780805690994479105
InstanceId	string	O ID da instância.	hgpostcn-cn-pe33jdxxxxx
StartTime	string	O timestamp de quando o backup foi iniciado. Formato: `YYYY-MM-DDTHH:mm:ss.SSSTZ` (UTC+8). Este formato é usado para todos os parâmetros relacionados a tempo.	2024-10-28T11:19:56.000+00:00
Status	string	O status do backup. Valores válidos: processing : O backup está em andamento. completed : O backup foi concluído. failed : O backup falhou.	completed
TriggerType	string	O tipo de acionamento do backup. Valores válidos: scheduled : Backup periódico. manual : Backup manual.	scheduled
DataDesc	string	A descrição do snapshot. Pode ser atualizada.	demo
DataTime	string	A hora em que o snapshot de dados foi criado. Para o formato, consulte StartTime.	2024-10-28T12:23:37.000+00:00
DataSize	integer	O tamanho do snapshot, em bytes.	76085723136
EndTime	string	A hora em que o backup foi concluído. Para o formato, consulte StartTime.	2024-10-28T12:27:34.000+00:00
ColdDataSize	integer	O tamanho dos dados frios, em bytes.	32413521
InstanceType	string	O tipo da instância. Valores válidos: Warehouse : Instância de virtual warehouse. Standard : Instância de uso geral.	Warehouse
InstanceRegion	string	A região onde a instância reside.	cn-hangzhou
SnapshotRegion	string	A região onde o snapshot está armazenado.	cn-hangzhou
InstanceZoneId	string	A zona onde a instância reside.	cn-hangzhou-j
SnapshotZoneId	string	A zona onde o(s) snapshot(s) de backup está(ão) armazenado(s). Se você usar armazenamento com redundância de zona, os dados serão armazenados em várias zonas. Este parâmetro retorna uma dessas zonas.	cn-hangzhou-j
InstanceName	string	O nome da instância.	my-hologres-dw

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46",
  "BackupDataList": [
    {
      "BackupType": "redundant",
      "DataGran": "instance",
      "Id": 1780805690994479000,
      "InstanceId": "hgpostcn-cn-pe33jdxxxxx",
      "StartTime": "2024-10-28T11:19:56.000+00:00",
      "Status": "completed",
      "TriggerType": "scheduled",
      "DataDesc": "demo",
      "DataTime": "2024-10-28T12:23:37.000+00:00",
      "DataSize": 76085723136,
      "EndTime": "2024-10-28T12:27:34.000+00:00",
      "ColdDataSize": 32413521,
      "InstanceType": "Warehouse",
      "InstanceRegion": "cn-hangzhou",
      "SnapshotRegion": "cn-hangzhou",
      "InstanceZoneId": "cn-hangzhou-j",
      "SnapshotZoneId": "cn-hangzhou-j",
      "InstanceName": "my-hologres-dw"
    }
  ]
}

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.