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

Consulta o status de renovação automática de um cluster ClickHouse Community-Compatible.

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

get

*DBCluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-beijing
DBClusterIds	string	Não	O ID do cluster.	cc-uf6g4417bo*****
PageSize	integer	Não	O número de entradas por página.	30
PageNumber	integer	Não	O número da página.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D0CEC6AC-7760-409A-A0D5-E*******
PageNumber	integer	O número da página.	1
PageRecordCount	integer	O número de entradas na página atual.	5
TotalRecordCount	integer	O número total de entradas.	51
Items	object
AutoRenewAttribute	array<object>	As informações de renovação automática.
	object
DBClusterId	string	The cluster ID.	cc-2ze57pg09*****
PeriodUnit	string	The subscription duration unit. Valid values: Month and Year.	Year
Duration	integer	The subscription duration.	1
RenewalStatus	string	The renewal status. Valid values: AutoRenewal: The cluster is automatically renewed. Normal: The cluster is manually renewed. NotRenewal: The cluster is not renewed upon expiration.	AutoRenewal
AutoRenewEnabled	boolean	Indicates whether auto-renewal is enabled. Valid values: true: Enabled. false: Disabled.
RegionId	string	The region ID.	cn-beijing

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E*******",
  "PageNumber": 1,
  "PageRecordCount": 5,
  "TotalRecordCount": 51,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "cc-2ze57pg09*****",
        "PeriodUnit": "Year",
        "Duration": 1,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": false,
        "RegionId": "cn-beijing"
      }
    ]
  }
}

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.