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

Visualiza os dados de desempenho de um cluster ApsaraDB for ClickHouse Community-Compatible Edition.

Descrição da operação

Você pode visualizar os dados de monitoramento de desempenho de um cluster especificado dentro de um intervalo de tempo com base em métricas de desempenho. Os dados são coletados a cada 30 segundos.

Nota

Esta operação suporta apenas clusters ApsaraDB for ClickHouse Community-Compatible Edition que foram criados antes de 1 de dezembro de 2021.

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

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-bp125e3uu94wo****
Key	string	Não	As métricas de desempenho que você deseja consultar. Separe vários nomes de métricas com uma vírgula (,). Você pode consultar até cinco métricas de desempenho por vez. As seguintes métricas de desempenho são suportadas: Nota Key é obrigatório. CPU: CPU_USAGE: A utilização de CPU. Memory: MEM_USAGE: A utilização de memória. MEM_USAGE_SIZE: O uso de memória em MB. Disk: DISK_USAGE: A utilização de disco. DISK_USAGE_SIZE: O uso de disco em MB. IOPS: As operações de entrada/saída de disco por segundo (IOPS). Connection: CONN_USAGE: A utilização de conexões de banco de dados. CONN_USAGE_COUNT: O número de conexões de banco de dados. Write: TPS: O número de linhas gravadas por segundo (TPS). INSERT_SIZE: O tamanho de gravação por segundo em MB. Query: QPS: As consultas por segundo (QPS). AVG_SEEK: O número de chamadas SEEK aleatórias. WAIT: ZK_WAIT: O tempo médio de espera do ZooKeeper (ZK) em ms. IO_WAIT: O tempo médio de espera de I/O em ms. CPU_WAIT: O tempo médio de espera de CPU em ms.	MEM_USAGE
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário em UTC usando o formato `yyyy-MM-ddTHH:mmZ`.	2021-11-27T16:37Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique o horário em UTC usando o formato `yyyy-MM-ddTHH:mmZ`. Nota O horário de término deve ser posterior ao horário de início. O intervalo de tempo máximo não pode exceder 32 dias.	2021-11-27T16:38Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	O fim do intervalo de tempo consultado. O horário está em UTC, formatado como `yyyy-MM-ddTHH:mmZ`.	2021-11-27T16:38Z
RequestId	string	O ID da solicitação.	FE242962-6DA3-5FC8-9691-37B62A3210F7
StartTime	string	O início do intervalo de tempo consultado. O horário está em UTC, formatado como `yyyy-MM-ddTHH:mmZ`.	2021-11-27T16:37Z
DBClusterId	string	O ID do cluster.	cc-bp125e3uu94wo****
Performances	array<object>	A lista de métricas de desempenho do cluster.
	array<object>	A métrica de desempenho.
Key	string	O nome da métrica de desempenho.	MEM_USAGE
Unit	string	A unidade da métrica.	%
Series	array<object>	Os dados de série temporal da métrica.
	array<object>	As informações da métrica.
Values	array<object>	The values of the performance metrics, each associated with a sampling timestamp.
	object	The metric value.
Point	array	The value of the performance metric.
	string	Detailed time-series data for the performance metric.	[ "2021-11-26T16:39:00Z","15.08" ]
Name	string	The name of the time series.	cc-bp125e3uu94wo1s0k16****
Name	string	O nome da métrica de desempenho.	mem_usage

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2021-11-27T16:38Z",
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7",
  "StartTime": "2021-11-27T16:37Z",
  "DBClusterId": "cc-bp125e3uu94wo****",
  "Performances": [
    {
      "Key": "MEM_USAGE",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[ \"2021-11-26T16:39:00Z\",\"15.08\" ]"
              ]
            }
          ],
          "Name": "cc-bp125e3uu94wo1s0k16****"
        }
      ],
      "Name": "mem_usage"
    }
  ]
}

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.