DescribeBackups - ApsaraDB for ClickHouse: Central de Documentação do Alibaba Cloud

Consulta os conjuntos de backup de um cluster ApsaraDB for ClickHouse especificado.

Descrição da operação

Nota

Apenas clusters ApsaraDB for ClickHouse da versão 21.8 ou posterior suportam o recurso de backup de dados.

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

clickhouse:DescribeBackups

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	cc-bp1qx68m06981****
BackupId	string	Não	O ID da tarefa de backup.	117403****
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-21T16:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-25T16:00Z
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 (padrão) 50 100	30
PageNumber	integer	Não	O número da página.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	string	O número total de entradas retornadas.	1
PageSize	string	O número de entradas por página. Valores válidos: 30 (padrão) 50 100	30
RequestId	string	O ID da solicitação.	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	string	O número da página.	1
Items	array<object>	A lista de conjuntos de backup.
	object
DBClusterId	string	O ID do cluster.	cc-bp1qx68m06981****
BackupStatus	string	O status do backup. Valores válidos: Success: O backup foi concluído. Failure: O backup falhou.	Success
BackupType	string	O tipo de backup. Valores válidos: FullBackup: backup completo. IncrementalBackup: backup incremental.	IncrementalBackup
BackupStartTime	string	A hora em que o backup começou. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-22T18:28:22Z
BackupSize	integer	O tamanho do backup. Unidade: MB.	131072
BackupEndTime	string	A hora em que o backup terminou. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-22T18:28:41Z
BackupSetInfo	string	O número de nós no cluster. Edição de réplica única: valores válidos: 1 a 48. Cluster mestre-réplica: valores válidos: 1 a 24.	{"shard_count": 4}
BackupId	string	O ID da tarefa de backup.	117403****
BackupMethod	string	O método de backup. O valor é Physical, que indica backup físico.	Physical
ExpireDate	string	A hora de expiração do conjunto de backup. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2022-07-22T18:28:41Z
BackupScheduleType	string	O tipo de backup. Valores válidos: manual (backup manual) e scheduled (backup automático).	manual

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": "1",
  "Items": [
    {
      "DBClusterId": "cc-bp1qx68m06981****",
      "BackupStatus": "Success",
      "BackupType": "IncrementalBackup",
      "BackupStartTime": "2021-11-22T18:28:22Z",
      "BackupSize": 131072,
      "BackupEndTime": "2021-11-22T18:28:41Z",
      "BackupSetInfo": "{\"shard_count\": 4}",
      "BackupId": "117403****",
      "BackupMethod": "Physical",
      "ExpireDate": "2022-07-22T18:28:41Z",
      "BackupScheduleType": "manual"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.