DescribePatternPerformance - AnalyticDB: Central de Documentação do Alibaba Cloud

Consulta as métricas de um padrão SQL, como a duração da consulta e o uso médio de memória em um determinado período.

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

adb:DescribePatternPerformance

get

DBCluster

acs:adb:{#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. Nota Você pode chamar a operação DescribeDBClusters para consultar as informações sobre todos os clusters do AnalyticDB for MySQL em uma região, incluindo os IDs dos clusters.	am-****************
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota Apenas os dados dos últimos 14 dias podem ser consultados. Por exemplo, se a data atual for 22 de novembro (UTC+8), você pode consultar dados a partir de 9 de novembro definindo StartTime como 2021-11-08T16:00:00Z. Se você definir StartTime com um valor anterior a 2021-11-08T16:00:00Z, o parâmetro Performances ficará vazio. O intervalo de tempo máximo que pode ser especificado é de 24 horas.	2021-11-18T00:00:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota A hora de término deve ser posterior à hora de início.	2021-11-18T18:05:00Z
RegionId	string	Sim	O ID da região do cluster. Nota Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
PatternId	string	Sim	O ID do padrão SQL. Nota Você pode chamar a operação DescribeSQLPatterns para consultar as informações sobre todos os padrões SQL em um cluster do AnalyticDB for MySQL dentro de um período de tempo, incluindo os IDs dos padrões SQL.	3847585356974******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
EndTime	string	A hora de término da consulta. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-11-18T18:05Z
RequestId	string	O ID da solicitação.	210f47011634026610213529******
StartTime	string	A hora de início da consulta. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-11-18T00:00Z
Performances	array<object>	As métricas de desempenho consultadas.
	array<object>	A métrica de desempenho consultada.
Key	string	A métrica de desempenho que foi consultada. Valores válidos: AnalyticDB_PatternQueryCount: o número total de consultas executadas em associação com o padrão SQL. AnalyticDB_PatternQueryTime: a quantidade total de tempo consumido pelas consultas executadas em associação com o padrão SQL. AnalyticDB_PatternExecutionTime: a duração total de execução das consultas executadas em associação com o padrão SQL. AnalyticDB_PatternPeakMemory: o uso máximo de memória das consultas executadas em associação com o padrão SQL. AnalyticDB_PatternScanSize: a quantidade de dados escaneados nas consultas executadas em associação com o padrão SQL.	AnalyticDB_PatternQueryCount
Unit	string	A unidade da métrica de desempenho. Valores válidos: Quando a métrica de desempenho está relacionada à duração da consulta (o valor de Key é AnalyticDB_PatternQueryTime ou AnalyticDB_PatternExecutionTime), ms é retornado. Quando a métrica de desempenho está relacionada ao uso de memória (o valor de Key é AnalyticDB_PatternPeakMemory), MB é retornado. Quando a métrica de desempenho está relacionada à quantidade de dados escaneados (o valor de Key é AnalyticDB_PatternScanSize), MB é retornado. Quando a métrica de desempenho está relacionada ao número de consultas (o valor de Key é AnalyticDB_PatternQueryCount), este parâmetro fica vazio.	ms
Series	array<object>	As métricas de desempenho consultadas.
	object	As métricas de desempenho consultadas.
Values	array	The queried performance metrics.
	string	The value of the performance metric.	[ "2021-11-18 13:38:00", "224" ]
Name	string	The name of the performance metric value. Valid values: When the `Key` parameter is set to `AnalyticDB_PatternQueryCount`, `pattern_query_count` is returned, which indicates the number of executions of the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternQueryTime`, the following values are returned: `average_query_time`, which indicates the average total amount of time consumed by the SQL statements in association with the SQL pattern. `max_query_time`, which indicates the maximum total amount of time consumed by the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternExecutionTime`, the following values are returned: `average_execution_time`, which indicates the average execution duration of the SQL statements in association with the SQL pattern. `max_execution_time`, which indicates the maximum execution duration of the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternPeakMemory`, the following values are returned: `average_peak_memory`, which indicates the average peak memory usage of the SQL statements in association with the SQL pattern. `max_peak_memory`, which indicates the maximum peak memory usage of the SQL statements in association with the SQL pattern. When the `Key` parameter is set `AnalyticDB_PatternScanSize`, the following values are returned: `average_scan_size`, which indicates the average amount of data scanned by the SQL statements in association with the SQL pattern. `max_scan_size`, which indicates the maximum amount of data scanned by the SQL statements in association with the SQL pattern.	max_query_time
AccessIp	string	O endereço IP do cliente SQL que envia o padrão SQL.	172.16.14.*
FailedCount	integer	O número de padrões SQL com falha dentro do intervalo de tempo.	0
QueryCount	integer	O número de consultas executadas em associação com o padrão SQL dentro do intervalo de tempo.	35018
SQLPattern	string	A instrução SQL que representa o padrão SQL.	SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?
Tables	string	As tabelas que estão associadas ao padrão SQL.	tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation
User	string	A conta do banco de dados que é usada para executar a instrução SQL.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2021-11-18T18:05Z",
  "RequestId": "210f47011634026610213529******",
  "StartTime": "2021-11-18T00:00Z",
  "Performances": [
    {
      "Key": "AnalyticDB_PatternQueryCount",
      "Unit": "ms",
      "Series": [
        {
          "Values": [
            "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
          ],
          "Name": "max_query_time"
        }
      ]
    }
  ],
  "AccessIp": "172.16.14.*",
  "FailedCount": 0,
  "QueryCount": 35018,
  "SQLPattern": "SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?",
  "Tables": "tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation",
  "User": "test"
}

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.