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

Descrição da operação

Nota

O backup de dados é compatível com clusters do ApsaraDB for ClickHouse executando a versão 20.3, 20.8 ou 21.8.

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:DescribeBackupPolicy

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	cc-bp1qx68m06981****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PreferredBackupPeriod	string	O ciclo de backup. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
Switch	string	Indica se o recurso de backup está ativado. Valores válidos: true: O recurso de backup está ativado. false: O recurso de backup está desativado.	true
RequestId	string	O ID da solicitação.	F5178C10-1407-4987-9133-DE4DC9119F75
PreferredBackupTime	string	O horário de backup em UTC.	15:00Z-16:00Z
BackupRetentionPeriod	integer	O período de retenção de backup. Valor padrão: 7. Valores válidos: 7 a 730. Unidade: dia.	7
BackupSize	string	O tamanho do backup. Unidade: MB.	123124

Exemplos

Resposta de sucesso

JSON formato

{
  "PreferredBackupPeriod": "Monday",
  "Switch": "true",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "BackupRetentionPeriod": 7,
  "BackupSize": "123124"
}

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.	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.