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

Consulta todos os dados de solicitação usando a dimensão de ID de SQL no Performance Insight (Nova Versão) para uma instância de banco de dados.

Descrição da operação

Pré-requisitos para o uso desta API:

Use a versão mais recente do SDK do Alibaba Cloud ou do DAS.
Ao chamar o serviço DAS usando o SDK, especifique a região como cn-shanghai.
A instância de banco de dados de destino é o RDS MySQL ou PolarDB MySQL.
A instância de banco de dados de destino deve ter o Performance Insight (Nova Versão) ativado. Para mais informações, consulte Performance Insight (Nova Versão).

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	O ID da instância de banco de dados.	rm-uf61swc4cru0b****
NodeId	string	Não	O ID do nó. Nota Forneça um ID de nó para instâncias de banco de dados do RDS MySQL Cluster Edition ou PolarDB for MySQL.	r-****-db-0
SqlId	string	Não	O ID do SQL. Nota Se você especificar um ID de SQL, o sistema retornará estatísticas apenas para esse ID de SQL. Se você deixar este parâmetro vazio, o sistema retornará estatísticas para toda a instância de banco de dados.	651b56fe9418d48edb8fdf0980ec****
Keywords	string	Não	Palavras-chave no texto SQL. Separe várias palavras-chave com espaços.	select update
StartTime	integer	Não	A hora de início da consulta, no formato de timestamp Unix, em milissegundos.	1675833788056
EndTime	integer	Não	A hora de término da consulta, no formato de timestamp Unix, em milissegundos. Nota A hora de término deve ser posterior à hora de início. Você pode consultar dados de qualquer período de sete dias dentro dos últimos 30 dias.	1679297005999
OrderBy	string	Não	O campo de ordenação. O valor padrão é count. count: Número de execuções. avgLatency: Tempo médio de execução. rowsExamined: Número total de linhas verificadas. rowsExaminedAvg: Número médio de linhas verificadas. rowsSentAvg: Número médio de linhas retornadas.	count
Asc	boolean	Não	Especifica se a ordenação deve ser em ordem crescente. O valor padrão é false. true: Sim. false: Não.	false
PageNo	integer	Não	O número da página para consultas paginadas. Começa em 1. O valor padrão é 1.	1
PageSize	integer	Não	O número máximo de registros por página para consultas paginadas. O valor padrão é 10. O valor máximo é 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Lista de resumos de SQL.
Message	string	A mensagem de resposta. Nota Se a solicitação for bem-sucedida, este parâmetro retornará Successful. Se falhar, retornará detalhes do erro, como um código de erro.	Successful
RequestId	string	O ID da solicitação.	54F3DBAE-9420-511A-9C29-265E8C04****
Data	object	Os dados de resposta.
Total	integer	O número total de registros.	264
List	array<object>	A lista de informações detalhadas.
	object	A lista de itens retornados.
UserId	string	User ID.	196278346919****
Psql	string	SQL template.	select ?
InstanceId	string	Instance ID.	rm-2ze8g2am97624****
NodeId	string	Node ID. Nota This parameter is returned for ApsaraDB RDS for MySQL Cluster Edition or PolarDB for MySQL database instances.	r-x****-db-0
SqlType	string	SQL type. Valid values: SELECT UPDATE DELETE	SELECT
LogicId	integer	Logical database ID.	58275984
SqlId	string	SQL template ID.	2e8147b5ca2dfc640dfd5e43d96a****
Timestamp	integer	Data timestamp in Unix time format, in milliseconds.	1643040000000
RtRate	number	Percentage of total execution duration.	0.1384
CountRate	number	Percentage of total executions.	0.0586
FullScan	boolean	Indicates whether a full table scan occurred. Valid values: true: Yes. false: No.	true
Count	integer	Total number of executions.	100000
ErrCount	integer	Number of errors.	0
WarnCount	integer	Number of warnings.	0
TotalLatency	number	Total execution duration, in milliseconds.	60913.256
MaxLatency	number	Maximum execution duration, in milliseconds.	36.233
AvgLatency	number	Average SQL execution duration, in milliseconds.	0.1717
RowsSent	integer	Number of rows returned.	0
RowsSendAvg	number	Average number of rows sent.	0
RowsExamined	integer	Total number of rows scanned.	100
RowsExaminedAvg	number	Average number of rows scanned.	0
RowsAffected	integer	Number of rows affected.	0
RowsAffectedAvg	number	Average number of rows affected.	0
TmpTables	integer	Number of temporary tables.	0
TmpDiskTables	integer	Number of temporary disk tables.	0
RowsSorted	integer	Number of rows sorted.	0
SortMergePasses	integer	Number of merge passes required by the sort algorithm.	0
PhysicalReads	integer	Number of physical nodes.	0
PhysicalAsyncReads	integer	Number of physical asynchronous nodes.	0
SemisyncDelayTime	number	Semi-synchronous replication delay, in milliseconds.	0.12
RowsSentAvg	number	Average number of rows returned per SQL statement.	0.52
LogicReads	integer	Number of logical nodes.	0
RedoWrites	integer	Number of redo nodes.	0
DataWriteTime	number	Data write time, in milliseconds.	0
DataWrites	integer	Number of writable data nodes.	0
DataReadTime	number	Data read time, in milliseconds.	0
DataReads	integer	Number of readable data nodes.	0
RwlockOsWaits	integer	Indicates whether read/write splitting is enabled. Valid values: 0: Disabled. 1: Enabled.	0
RwlockSpinRounds	integer	Read/write splitting parameter.	0
RwlockSpinWaits	integer	Indicates whether multiple index scans are enabled. Valid values: 0: Disabled. 1: Enabled.	0
MutexWaits	integer	Number of mutex waits.	1
MutexSpins	integer	Number of mutex spins.	1
TransactionLockTime	number	Transaction lock time, in milliseconds.	0
ServerLockTime	number	Server lock time, in milliseconds.	0
CpuTime	number	CPU runtime, in milliseconds.	0
ElapsedTime	number	Actual runtime, in milliseconds.	0
Id	integer	Primary key ID.	26186357
SelectScanAvg	number	Average number of scans.	0
SelectRangeAvg	number	Average range selection.	0
SelectFullJoinAvg	number	The average number of connections that perform table scans without using an index. Importante If this parameter value is not 0, carefully check the indexes of the table.	0
SelectFullRangeJoinAvg	number	Average number of range joins.	0
SortScanAvg	number	Average number of sorted scans.	0
SortRowsAvg	number	Average number of sorted rows.	0
TmpTablesAvg	number	Average number of temporary tables.	0
TmpDiskTablesAvg	number	Average number of temporary disk tables.	0
FirstTime	integer	First execution time, in Unix time format, in milliseconds.	1659308149000
LastTime	integer	Last update time, in Unix time format, in milliseconds.	1661306520000
LockLatencyAvg	number	Average lock wait time, in milliseconds.	0
TimerWaitAvg	number	Reserved parameter.	None
SortRangeAvg	number	Average number of range-based sorts.	0
CpuRate	number	Ratio of CPU execution time to total SQL execution time.	0
Db	string	Database name.	testDB
Tables	array	Database table names.
	string	Database table name.	test_table
PageNo	integer	O número da página.	1
PageSize	integer	O número máximo de registros por página.	10
Extra	any	Parâmetro reservado.	None
Code	integer	O código de status da resposta.	200
Success	boolean	Indica se a solicitação foi bem-sucedida: true: Bem-sucedida. false: Falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Successful",
  "RequestId": "54F3DBAE-9420-511A-9C29-265E8C04****",
  "Data": {
    "Total": 264,
    "List": [
      {
        "UserId": "196278346919****",
        "Psql": "select ?",
        "InstanceId": "rm-2ze8g2am97624****",
        "NodeId": "r-x****-db-0",
        "SqlType": "SELECT",
        "LogicId": 58275984,
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "Timestamp": 1643040000000,
        "RtRate": 0.1384,
        "CountRate": 0.0586,
        "FullScan": true,
        "Count": 100000,
        "ErrCount": 0,
        "WarnCount": 0,
        "TotalLatency": 60913.256,
        "MaxLatency": 36.233,
        "AvgLatency": 0.1717,
        "RowsSent": 0,
        "RowsSendAvg": 0,
        "RowsExamined": 100,
        "RowsExaminedAvg": 0,
        "RowsAffected": 0,
        "RowsAffectedAvg": 0,
        "TmpTables": 0,
        "TmpDiskTables": 0,
        "RowsSorted": 0,
        "SortMergePasses": 0,
        "PhysicalReads": 0,
        "PhysicalAsyncReads": 0,
        "SemisyncDelayTime": 0.12,
        "RowsSentAvg": 0.52,
        "LogicReads": 0,
        "RedoWrites": 0,
        "DataWriteTime": 0,
        "DataWrites": 0,
        "DataReadTime": 0,
        "DataReads": 0,
        "RwlockOsWaits": 0,
        "RwlockSpinRounds": 0,
        "RwlockSpinWaits": 0,
        "MutexWaits": 1,
        "MutexSpins": 1,
        "TransactionLockTime": 0,
        "ServerLockTime": 0,
        "CpuTime": 0,
        "ElapsedTime": 0,
        "Id": 26186357,
        "SelectScanAvg": 0,
        "SelectRangeAvg": 0,
        "SelectFullJoinAvg": 0,
        "SelectFullRangeJoinAvg": 0,
        "SortScanAvg": 0,
        "SortRowsAvg": 0,
        "TmpTablesAvg": 0,
        "TmpDiskTablesAvg": 0,
        "FirstTime": 1659308149000,
        "LastTime": 1661306520000,
        "LockLatencyAvg": 0,
        "TimerWaitAvg": 0,
        "SortRangeAvg": 0,
        "CpuRate": 0,
        "Db": "testDB",
        "Tables": [
          "test_table"
        ]
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None"
  },
  "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.