GetQueryOptimizeDataStats - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Retorna estatísticas de modelos SQL a partir de dados de governança de consultas.

Descrição da operação

Se você usar um SDK do Alibaba Cloud, certifique-se de que a versão do aliyun-sdk-core seja posterior à V2.1.8. Recomendamos o uso da versão mais recente.
A versão do seu SDK do Database Autonomy Service (DAS) deve ser V2.1.8 ou posterior.
Se você usar um SDK para chamar operações de API do DAS, deverá definir o ID da região como cn-shanghai.
Esta operação oferece suporte aos seguintes mecanismos de banco de dados:
- ApsaraDB RDS for MySQL.
- PolarDB for MySQL.
- ApsaraDB RDS for PostgreSQL.

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

hdm:GetQueryOptimizeDataStats

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Engine	string	Sim	O mecanismo de banco de dados. Valores válidos: MySQL PolarDBMySQL PostgreSQL	MySQL
InstanceIds	string	Não	Os IDs das instâncias. Separe vários IDs com vírgulas (,).	rm-2ze8g2am97624****
TagNames	string	Não	O parâmetro reservado.	None
Keywords	string	Não	As palavras-chave do modelo SQL. Separe várias palavras-chave com espaços.	select update
LogicalOperator	string	Não	A relação lógica entre várias palavras-chave. Valores válidos: or and	or
Rules	string	Não	As tags usadas para filtrar modelos SQL. Separe várias tags com vírgulas (,). Para obter mais informações, consulte Governança de consultas.	DAS_NOT_IMPORTANT
DbNames	string	Não	O nome do banco de dados a ser consultado.	testdb01
Time	string	Sim	O intervalo de tempo a ser consultado. Especifique o tempo no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1642953600000
PageSize	string	Não	O número de entradas por página. Valor padrão: 10.	10
PageNo	string	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
OrderBy	string	Não	O campo pelo qual classificar as entradas retornadas. Valor padrão: count. Valores válidos: count: o número de execuções. maxQueryTime: o maior tempo de execução. avgQueryTime: o tempo médio de execução. maxLockTime: o maior tempo de espera de bloqueio. avgLockTime: o tempo médio de espera de bloqueio. maxRowsExamined: o maior número de linhas verificadas. avgRowsExamined: o número médio de linhas verificadas. maxRowsSent: o maior número de linhas retornadas. avgRowsSent: o número médio de linhas retornadas.	count
Asc	string	Não	Especifica se as entradas retornadas devem ser classificadas em ordem crescente. Valor padrão: true. Valores válidos: true: classifica as entradas retornadas em ordem crescente. false: não classifica as entradas retornadas em ordem crescente.	true
OnlyOptimizedSql	string	Não	Especifica se devem ser consultados apenas modelos SQL que precisam ser otimizados. Valor padrão: false. Valores válidos: true: consulta apenas modelos SQL que precisam ser otimizados. false: não consulta apenas modelos SQL que precisam ser otimizados.	false
SqlIds	string	Não	O ID do modelo SQL. Você pode consultar o ID de um modelo chamando a operação GetQueryOptimizeExecErrorStats.	2e8147b5ca2dfc640dfd5e43d96a****
Region	string	Não	A região na qual a instância reside. Valores válidos: cn-china: China continental cn-hongkong: China (Hong Kong) ap-southeast-1: Singapura Este parâmetro só entra em vigor se InstanceIds for deixado vazio. Se você deixar InstanceIds vazio, o sistema obterá dados da região definida por Region. Por padrão, Region é definido como cn-china. Se você especificar InstanceIds, Region não entrará em vigor e o sistema obterá dados da região na qual a primeira instância especificada reside.** Nota Defina este parâmetro como cn-china** para as instâncias criadas nas regiões da China continental.	cn-china
User	string	Não	A conta do banco de dados a ser consultado.	testUser

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Code	string	O código de status HTTP retornado.	200
Message	string	A mensagem retornada.	Successful
Data	object	Os dados retornados.
Total	integer	O número total de entradas retornadas.	10
PageNo	integer	O parâmetro reservado.	None
PageSize	integer	O parâmetro reservado.	None
Extra	string	O parâmetro reservado.	None
List	array<object>	As informações sobre os modelos SQL.
	array<object>
InstanceId	string	The instance ID.	rm-2ze8g2am97624****
Dbname	string	The name of the database to which the SQL template belongs.	testdb01
SqlId	string	The SQL template ID.	2e8147b5ca2dfc640dfd5e43d96a****
SqlType	string	The type of the SQL statement.	INSERT
Psql	string	The SQL template.	select 1
SqlSample	string	The sample query that took the longest time to execute.	select 2
Count	integer	The number of times that the SQL template is executed.	100
MaxQueryTime	number	The longest query execution time. Unit: seconds.	1.1
AvgQueryTime	number	The average query execution time. Unit: seconds.	1.1
MaxLockTime	number	The longest lock wait time. Unit: seconds.	0.1
AvgLockTime	number	The average lock wait time. Unit: seconds.	0.1
MaxRowsExamined	integer	The largest number of scanned rows.	100000
AvgRowsExamined	number	The average number of scanned rows.	100.1
MaxRowsSent	integer	The largest number of returned rows.	10000
AvgRowsSent	number	The average number of returned rows.	100.1
MaxRowsAffected	integer	The largest number of rows affected by the SQL template. Nota A value of -1 indicates that this parameter is not collected.	10000
AvgRowsAffected	number	The average number of rows affected by the SQL statement. Nota A value of -1 indicates that this parameter is not collected.	100.1
RuleList	array<object>	The information about the rules.
	object
Name	string	The rule name.	DAS_NOT_IMPORTANT
Type	string	The type of the rule. Valid values: Predefined UserDefined	Predefined
User	string	The account of the database.	testUser
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: a solicitação foi bem-sucedida. false: a solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 10,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlType": "INSERT",
        "Psql": "select 1",
        "SqlSample": "select 2",
        "Count": 100,
        "MaxQueryTime": 1.1,
        "AvgQueryTime": 1.1,
        "MaxLockTime": 0.1,
        "AvgLockTime": 0.1,
        "MaxRowsExamined": 100000,
        "AvgRowsExamined": 100.1,
        "MaxRowsSent": 10000,
        "AvgRowsSent": 100.1,
        "MaxRowsAffected": 10000,
        "AvgRowsAffected": 100.1,
        "RuleList": [
          {
            "Name": "DAS_NOT_IMPORTANT",
            "Type": "Predefined"
          }
        ],
        "User": "testUser"
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.