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

Coleta assincronamente as estatísticas completas de solicitação nos resultados do SQL Explorer de uma instância de banco de dados por ID de SQL.

Descrição da operação

Nota

GetFullRequestStatResultByInstanceId é uma operação assíncrona. Após o envio de uma solicitação, os resultados completos não são retornados imediatamente. Se o valor do parâmetro isFinish for false na resposta, aguarde 1 segundo e envie a solicitação novamente. Se o valor do parâmetro isFinish for true, os resultados completos serão retornados.

O recurso SQL Explorer permite verificar o status de integridade das instruções SQL e solucionar problemas de desempenho. Para obter mais informações, consulte SQL Explorer.

Para obter mais informações sobre as instâncias de banco de dados que suportam este recurso, consulte Visão geral do DAS Enterprise Edition.
Se você usar um SDK para chamar as operações de API do Database Autonomy Service (DAS), deverá definir o ID da região como cn-shanghai.
Ao chamar esta operação, o valor do parâmetro SqlId muda devido à otimização do algoritmo de modelo SQL a partir de 1º de setembro de 2024. Para obter mais informações, consulte [Aviso] Otimização do algoritmo de modelo SQL.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
UserId	string	Não	O ID da conta Alibaba Cloud que foi usada para criar a instância de banco de dados. Nota Este parâmetro é opcional. O sistema pode obter automaticamente o ID da conta Alibaba Cloud com base no valor de InstanceId ao chamar a operação GetFullRequestOriginStatByInstanceId.	196278346919****
InstanceId	string	Sim	O ID da instância.	rm-2ze8g2am97624****
NodeId	string	Não	O ID do nó. Nota Você deve especificar o ID do nó se a sua instância de banco de dados for um cluster PolarDB for MySQL.	pi-bp12v7243x012****
SqlId	string	Não	O ID do SQL. Nota Se este parâmetro for especificado, as estatísticas completas de solicitação da consulta SQL especificada serão coletadas. Se este parâmetro for deixado em branco, as estatísticas completas de solicitação de toda a instância de banco de dados serão coletadas.	d71f82be1eef72bd105128204d2e****
OriginHost	string	Não	O endereço IP do cliente que executa a instrução SQL. Nota Este parâmetro é opcional. Se este parâmetro for especificado, as estatísticas completas de solicitação do endereço IP especificado serão coletadas. Se este parâmetro for deixado em branco, as estatísticas completas de solicitação de toda a instância de banco de dados serão coletadas.	172.26.XX.XXX
Keyword	string	Não	As palavras-chave usadas para a consulta.	dbtest01
Start	integer	Sim	O início do intervalo de tempo a ser consultado. Defina este parâmetro como um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Nota O horário de início pode ser de até 90 dias antes do horário atual.	1645581813000
End	integer	Sim	O fim do intervalo de tempo a ser consultado. Defina este parâmetro como um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Nota O horário de término deve ser posterior ao horário de início. O intervalo não pode exceder um dia.	1645668213000
OrderBy	string	Não	O campo pelo qual ordenar as entradas retornadas. Valor padrão: count. Valores válidos: count: o número de execuções. avgRt: a duração média de execução. rtRate: a porcentagem da duração de execução. rowsExamined: o número total de linhas verificadas. avgRowsExamined: o número médio de linhas verificadas. avgRowsReturned: o número médio de linhas retornadas.	count
Asc	boolean	Não	Especifica se os resultados devem ser ordenados em ordem crescente. Por padrão, os resultados não são ordenados em ordem crescente.	False
PageNo	integer	Sim	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	Sim	O número de entradas por página. Valor padrão: 20.	20
SqlType	string	Não	O tipo da instrução SQL. Valores válidos: SELECT, INSERT, UPDATE, DELETE, LOGIN, LOGOUT, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE, DROP, SET, DESC, REPLACE, CALL, BEGIN, DESCRIBE, ROLLBACK, FLUSH, USE, SHOW, START, COMMIT e RENAME. Nota Se a sua instância de banco de dados for uma instância ApsaraDB RDS for MySQL, um cluster PolarDB for MySQL ou uma instância PolarDB-X 2.0, as estatísticas podem ser coletadas com base no tipo de instrução SQL.	SELECT
DbName	string	Não	O nome do banco de dados.	dbtest01
Role	string	Não	A função do nó na instância PolarDB-X 2.0. Valores válidos: polarx_cn: nó de computação. polarx_dn: nó de dados.	polarx_cn

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro contendo informações como um código de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	7172BECE-588A-5961-8126-C216E16B****
Data	object	Os dados retornados.
Result	object	Os dados completos da solicitação retornados.
List	array<object>	The full request data.
	object
SqlId	string	The SQL ID.	d71f82be1eef72bd105128204d2e****
AvgFetchRows	integer	The average number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
AvgLockWaitTime	number	The average lock wait latency. Unit: seconds.	0.00009589874265269765
AvgLogicalRead	number	The average number of logical reads.	654.4470327860251
AvgPhysicalAsyncRead	integer	The average number of physical asynchronous reads.	0
AvgPhysicalSyncRead	integer	The average number of physical synchronous reads.	0
AvgExaminedRows	number	The average number of scanned rows. Nota This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
AvgReturnedRows	number	The average number of returned rows.	10000
AvgUpdatedRows	integer	The average number of updated rows. Nota This parameter is returned only for ApsaraDB RDS for MySQL and PolarDB-X 2.0 databases.	10000
AvgRt	number	The average execution duration.	2.499
AvgSqlCount	integer	The average number of SQL statements.	10000
Count	integer	The total number of executions.	100000
CountRate	number	The percentage of the total number of executions.	0.0586
Database	string	The name of the database.	dbtest01
ErrorCount	integer	The number of failed executions.	1
FetchRows	integer	The number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
Ip	string	The IP address of the database instance.	rm-uf6dyi58dm6**.mysql.rds.aliy**.com
LockWaitTime	number	The lock wait latency. Unit: seconds.	1089.4177720290281
LogicalRead	integer	The number of logical reads.	7.434573266E9
PhysicalAsyncRead	integer	The number of physical asynchronous reads.	0
PhysicalSyncRead	integer	The number of physical synchronous reads.	0
Port	integer	The port number that is used to connect to the database instance.	3306
Psql	string	The SQL template.	select * from dbtest01 where ****
Rows	integer	The total number of rows updated or returned by the compute nodes of the PolarDB-X 2.0 instance.	0
ExaminedRows	integer	The total number of scanned rows. Nota This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
RtGreaterThanOneSecondCount	integer	The number of SQL statements that take longer than 1 second to execute.	20
RtRate	number	The execution duration percentage.	2.499
SqlCount	integer	The number of SQL statements.	200
SumUpdatedRows	integer	The total number of updated rows.	100
Tables	array	The names of tables in the database.
	string	The names of tables in the database.	tabletest01,tabletest02
Version	integer	The version number.	1
VpcId	string	The virtual private cloud (VPC) ID.	vpc-2zentqj1sk4qmolci****
Total	integer	The total number of entries returned.	1
Fail	boolean	Indica se a solicitação assíncrona falhou. Valores válidos: true false	false
IsFinish	boolean	Indica se a solicitação assíncrona foi concluída. Valores válidos: true false	true
ResultId	string	O ID da solicitação.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
State	string	O estado da solicitação assíncrona. Valores válidos: RUNNING SUCCESS FAIL	SUCCESS
Timestamp	integer	O horário em que a solicitação assíncrona foi enviada. O valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1645668213000
Code	integer	O código de status HTTP retornado.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Successful",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Data": {
    "Result": {
      "List": [
        {
          "SqlId": "d71f82be1eef72bd105128204d2e****",
          "AvgFetchRows": 0,
          "AvgLockWaitTime": 0.00009589874265269765,
          "AvgLogicalRead": 654.4470327860251,
          "AvgPhysicalAsyncRead": 0,
          "AvgPhysicalSyncRead": 0,
          "AvgExaminedRows": 10000,
          "AvgReturnedRows": 10000,
          "AvgUpdatedRows": 10000,
          "AvgRt": 2.499,
          "AvgSqlCount": 10000,
          "Count": 100000,
          "CountRate": 0.0586,
          "Database": "dbtest01",
          "ErrorCount": 1,
          "FetchRows": 0,
          "Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
          "LockWaitTime": 1089.4177720290281,
          "LogicalRead": 7434573266,
          "PhysicalAsyncRead": 0,
          "PhysicalSyncRead": 0,
          "Port": 3306,
          "Psql": "select * from dbtest01 where ****",
          "Rows": 0,
          "ExaminedRows": 10000,
          "RtGreaterThanOneSecondCount": 20,
          "RtRate": 2.499,
          "SqlCount": 200,
          "SumUpdatedRows": 100,
          "Tables": [
            "tabletest01,tabletest02"
          ],
          "Version": 1,
          "VpcId": "vpc-2zentqj1sk4qmolci****"
        }
      ],
      "Total": 1
    },
    "Fail": false,
    "IsFinish": true,
    "ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
    "State": "SUCCESS",
    "Timestamp": 1645668213000
  },
  "Code": 200,
  "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.