Todos os produtos
Search

Este produto

    AnalyticDB:DescribeSQLPatterns

    Central de documentação

    AnalyticDB:DescribeSQLPatterns

    Última atualização: Jun 28, 2026

    Chama a API `DescribeSQLPatterns` para obter padrões SQL de um cluster AnalyticDB for MySQL dentro de um intervalo de datas especificado.

    Descrição da operação

    • Endpoint público global: adb.aliyuncs.com.

    • Endpoint público regional: adb.<region-id>.aliyuncs.com. Por exemplo: adb.cn-hangzhou.aliyuncs.com.

    • Endpoint VPC regional: adb-vpc.<region-id>.aliyuncs.com. Por exemplo: adb-vpc.cn-hangzhou.aliyuncs.com.

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

    list

    DBCluster

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

    		 Nenhuma 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 detalhes, incluindo IDs de cluster, de todos os clusters AnalyticDB for MySQL em uma região específica.

    am-bp1r053byu48p****
    StartTime

    string

    Sim

    O início do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.

    Nota

    • Você pode consultar dados apenas dos últimos 14 dias. Por exemplo, se o horário atual for 2021-11-22T12:00:00Z, o horário mais antigo que pode ser consultado é 2021-11-09T12:00:00Z.

    • O intervalo entre o horário de início e o horário de término não pode exceder 24 horas.

    2021-09-30T00:10:00Z
    EndTime

    string

    Sim

    O fim do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.

    Nota

    O horário de término deve ser posterior ao horário de início.

    2021-09-30T00:15:00Z
    RegionId

    string

    Sim

    O ID da região.

    Nota

    Você pode chamar a operação DescribeRegions para consultar as regiões e zonas de disponibilidade disponíveis para o AnalyticDB for MySQL, incluindo os IDs de região.

    cn-hangzhou
    Keyword

    string

    Não

    A palavra-chave para filtrar padrões SQL.

    SELECT
    Order

    string

    Sim

    Especifica como ordenar os resultados da consulta. Defina este parâmetro como uma string JSON. Exemplo: [{"Field":"AverageQueryTime","Type":"Asc"}]. A string JSON contém os seguintes campos:

    • Field: O campo de ordenação. Valores válidos:

      • PatternCreationTime: o horário de envio mais antigo do padrão SQL dentro do intervalo de tempo especificado.

      • AverageQueryTime: o tempo médio total de consulta do padrão SQL dentro do intervalo de tempo especificado.

      • MaxQueryTime: o tempo máximo total de consulta do padrão SQL dentro do intervalo de tempo especificado.

      • AverageExecutionTime: o tempo médio de execução do padrão SQL dentro do intervalo de tempo especificado.

      • MaxExecutionTime: o tempo máximo de execução do padrão SQL dentro do intervalo de tempo especificado.

      • AveragePeakMemory: o uso médio de memória de pico do padrão SQL dentro do intervalo de tempo especificado.

      • MaxPeakMemory: o uso máximo de memória de pico do padrão SQL dentro do intervalo de tempo especificado.

      • AverageScanSize: a quantidade média de dados verificados pelo padrão SQL dentro do intervalo de tempo especificado.

      • MaxScanSize: a quantidade máxima de dados verificados pelo padrão SQL dentro do intervalo de tempo especificado.

      • QueryCount: o número de vezes que o padrão SQL é executado dentro do intervalo de tempo especificado.

      • FailedCount: o número de execuções com falha do padrão SQL dentro do intervalo de tempo especificado.

    • Type: a ordem de classificação. Valores válidos (não diferencia maiúsculas de minúsculas):

      • Asc: ordem crescente.

      • Desc: ordem decrescente.

    [{"Field":"AverageQueryTime","Type":"Asc"}]
    PageNumber

    integer

    Não

    O número da página. O valor deve ser um inteiro maior que 0.

    Nota

    O valor padrão é 1.

    1
    PageSize

    integer

    Não

    O número de entradas por página. Valores válidos:

    • 30

    • 50

    • 100

    Nota

    O valor padrão é 30.

    30
    Lang

    string

    Não

    O idioma da resposta. Este parâmetro é usado para localizar mensagens como detalhes de erro. Valores válidos:

    • zh: Chinês Simplificado (padrão)

    • en: Inglês

    • ja: Japonês

    • zh-tw: Chinês Tradicional

    zh
    UserName

    string

    Não

    O nome de usuário usado para filtrar os padrões SQL. Se você especificar este parâmetro, apenas os padrões SQL do usuário especificado serão retornados.

    test_user
    SqlPatternHash

    integer

    Não

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os dados retornados para a solicitação.

    PageNumber

    integer

    O número da página.

    1
    PageSize

    integer

    O número de entradas retornadas por página.

    30
    TotalCount

    integer

    O número total de entradas retornadas.

    1
    PatternDetails

    array<object>

    Os detalhes dos padrões SQL.

    object

    Os detalhes de um padrão SQL.

    SQLPattern

    string

    A instrução do padrão SQL.

    SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
    PatternId

    string

    O ID do padrão SQL.

    5575924945138******
    User

    string

    O nome de usuário do banco de dados que enviou as instruções SQL correspondentes a este padrão.

    reporter
    AccessIp

    string

    O endereço IP do cliente a partir do qual as instruções SQL correspondentes a este padrão foram enviadas.

    192.168.xx.xx
    Tables

    string

    A tabela do banco de dados verificada pelas consultas neste padrão.

    tpch.orders
    PatternCreationTime

    string

    O horário mais antigo em que uma consulta correspondente a este padrão foi enviada dentro do intervalo de tempo especificado. O horário está no formato YYYY-MM-DD HH:MM:SS.

    2021-11-12 03:06:00
    AverageQueryTime

    number

    O tempo médio de consulta para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em milissegundos.

    4
    MaxQueryTime

    integer

    O tempo máximo de consulta para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em milissegundos.

    2341
    AverageExecutionTime

    number

    O tempo médio de execução para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em milissegundos.

    234.78
    MaxExecutionTime

    integer

    O tempo máximo de execução para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em milissegundos.

    2142
    AveragePeakMemory

    number

    O uso médio de memória de pico para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em bytes.

    234.22
    MaxPeakMemory

    integer

    O uso máximo de memória de pico para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em bytes.

    234149
    AverageScanSize

    number

    O tamanho médio de verificação de dados para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em bytes.

    234149.23
    MaxScanSize

    integer

    O tamanho máximo de verificação de dados para instruções correspondentes a este padrão SQL dentro do intervalo de tempo especificado, em bytes.

    234149
    QueryCount

    integer

    O número de execuções para instruções correspondentes a este padrão dentro do intervalo de tempo especificado.

    345
    FailedCount

    integer

    O número de execuções com falha para instruções correspondentes a este padrão dentro do intervalo de tempo especificado.

    234
    Blockable

    boolean

    Especifica se as consultas correspondentes a este padrão podem ser bloqueadas. Valores válidos:

    • true: O padrão SQL pode ser bloqueado.

    • false: O padrão SQL não pode ser bloqueado.

    Nota

    O AnalyticDB for MySQL suporta bloqueio apenas para instruções SELECT e INSERT.

    true
    QueryTimeSum

    number

    O tempo total de consulta para instruções correspondentes a este padrão, em milissegundos.

    5
    QueryTimePercentage

    number

    A porcentagem do tempo total de consulta de todos os padrões que as consultas deste padrão consomem.

    10
    PeakMemorySum

    number

    O total de memória de pico usada por instruções correspondentes a este padrão, em bytes.

    5
    PeakMemoryPercentage

    number

    A porcentagem do uso total de memória de pico de todos os padrões que as consultas deste padrão consomem.

    10
    ScanSizeSum

    number

    O tamanho total de verificação de dados para instruções correspondentes a este padrão, em bytes.

    5
    ScanSizePercentage

    number

    A porcentagem do tamanho total de verificação de dados de todos os padrões que as consultas deste padrão consomem.

    80
    AverageOperatorCost

    number

    O custo médio de CPU para instruções correspondentes a este padrão, em milissegundos.

    5
    MaxOperatorCost

    number

    O custo máximo de CPU para instruções correspondentes a este padrão, em milissegundos.

    5
    OperatorCostSum

    number

    O custo total de CPU para instruções correspondentes a este padrão, em milissegundos.

    5
    OperatorCostPercentage

    number

    A porcentagem do custo total de CPU de todos os padrões que as consultas deste padrão consomem.

    20
    AverageScanCost

    number

    O custo médio de CPU de verificações de tabela para instruções correspondentes a este padrão, em milissegundos.

    5
    MaxScanCost

    number

    O custo máximo de CPU de verificações de tabela para instruções correspondentes a este padrão, em milissegundos.

    5
    ScanCostSum

    number

    O custo total de CPU de verificações de tabela para instruções correspondentes a este padrão, em milissegundos.

    5
    ScanCostPercentage

    number

    A porcentagem do custo total de CPU de todas as verificações de tabela que as consultas deste padrão consomem.

    5
    RequestId

    string

    O ID da solicitação.

    6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

    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.