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

Chama DescribeSqlLogRecords para consultar detalhes de log no DAS Enterprise Edition.

Descrição da operação

Antes de chamar esta operação, observe o seguinte:

Ao usar um SDK do Alibaba Cloud ou do Database Autonomy Service (DAS), recomendamos que você use a versão mais recente.
Ao chamar o serviço DAS usando um SDK, você deve definir a região como cn-shanghai.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância de banco de dados.	pc-2ze8g2am97624****
NodeId	string	Não	O ID do nó. Este parâmetro é aplicável apenas a instâncias de cluster ApsaraDB RDS for MySQL e PolarDB for MySQL. Se este parâmetro for omitido, os detalhes de log do nó primário serão retornados por padrão. Para PolarDB-X 2.0, defina este parâmetro como polarx_cn (nó de computação) ou polarx_dn (nó de dados).	pi-uf6k5f6g3912i****
Role	string	Não	A função do nó na instância de banco de dados PolarDB-X 2.0. polarx_cn: nó de computação. polarx_dn: nó de dados.	polarx_cn
Filters	array<object>	Não	Uma lista de condições de filtro.
	object	Não	A condição de filtro.
Key	string	Não	A chave de filtro. Nota Para detalhes sobre as chaves de filtro suportadas e seus valores, consulte Informações adicionais sobre parâmetros de solicitação.	keyWords
Value	string	Não	O valor de filtro.	select
StartTime	integer	Não	O início do intervalo de tempo a ser consultado. Este é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1596177993000
EndTime	integer	Não	O fim do intervalo de tempo a ser consultado. Este é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1608888296000
PageNo	integer	Não	O número da página. As páginas começam a partir da página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 100. Valor padrão: 10.	10

Os seguintes valores são suportados para o parâmetro Key:

KeyWords: As palavras-chave para a consulta. Separe múltiplas palavras-chave com um espaço.
LogicalOperator: O operador lógico que conecta palavras-chave. Valores válidos: and e or.
AccountName: O nome de usuário do banco de dados. Você pode especificar até cinco nomes de usuário, separados por vírgulas.
dbName: O nome do banco de dados. Você pode especificar até cinco nomes de banco de dados, separados por vírgulas.
HostAddress: O endereço IP do cliente. Você pode especificar até cinco endereços IP, separados por vírgulas.
MaxConsume: A duração máxima de execução, em microssegundos.
MinConsume: A duração mínima de execução, em microssegundos.
MaxScanRows: O número máximo de linhas verificadas.
MinScanRows: O número mínimo de linhas verificadas.
SqlType: O tipo de SQL. Valores válidos: select, update, insert e delete.
State: O estado de execução. Valores válidos: 0 (bem-sucedido) e 1 (falhou).
ThreadId: O ID do thread.
SortKey: A chave de ordenação. Valores válidos: ScanRows (número de linhas verificadas), UpdateRows (número de linhas atualizadas), Consume (duração da execução), ExecuteTime (hora de execução), ReturnRows (número de linhas retornadas), LockTime (tempo de espera de bloqueio), Frows (número de linhas buscadas por um nó de computação (CN)), Scnt (número de solicitações de um CN para um nó de dados (DN)), CpuTime (tempo de execução de CPU) e PhysicalRead (leituras físicas).
SortMethod: A ordem de classificação. Valores válidos: DESC (decrescente) e ASC (crescente). Valor padrão: DESC.
TraceId: O ID de rastreamento.
MinRows: O número mínimo de linhas atualizadas.
MaxRows: O número máximo de linhas atualizadas.
MinScnt: O número mínimo de solicitações de um CN para um DN.
MaxScnt: O número máximo de solicitações de um CN para um DN.
TrxId: O ID da transação.
Fail: O código de erro.
SqlId: O ID do SQL.
JobId: O ID da tarefa assíncrona. Use este ID para consultar o resultado da execução da tarefa.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O nó raiz.
Code	string	O código de status HTTP.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Caso contrário, uma mensagem de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE
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
Data	object	Os dados retornados.
StartTime	integer	A hora de início da consulta. Este valor é um timestamp UNIX. Unidade: milissegundos.	1596177993000
EndTime	integer	A hora de término da consulta. Este valor é um timestamp UNIX. Unidade: milissegundos.	1608888296000
TotalRecords	integer	O número total de entradas retornadas.	1
Items	object	Os detalhes dos logs SQL.
SQLLogRecord	array<object>	The SQL log data.
	object	The SQL log data.
Ext	string	The extended information. This parameter is reserved.	None
ExecuteTime	string	The execution time. The time is in UTC. Format: `yyyy-MM-ddTHH:mm:ssZ`.	2023-12-07T02:15:32Z
OriginTime	integer	The execution time. This value is a UNIX timestamp. Unit: milliseconds.	1701886532000
HostAddress	string	The client IP address.	11.197.XX.XX
UpdateRows	integer	The number of updated rows.	0
LogicRead	integer	The number of logical reads.	0
SqlText	string	The SQL statement.	select resource_id as cluster_id, tpl_name \n\tfrom dbfree_alert_resource_tpl_ref\n\twhere user_id=? and type='cluster' group by resource_id, tpl_name
LockTime	integer	The lock wait time. Unit: milliseconds.	0
ScanRows	integer	The number of scanned rows.	0
ThreadId	integer	The thread ID.	None
State	string	The execution status. Valid values: 0: The execution was successful. 1: The execution failed.	0
DBName	string	The database name.	testdb
SqlType	string	The type of the SQL statement.	select
AccountName	string	The database account.	testname
PhysicSyncRead	integer	The number of synchronous physical reads.	0
PhysicAsyncRead	integer	The number of asynchronous physical reads.	0
TrxId	string	The transaction ID.	200000
ReturnRows	integer	The number of returned rows.	0
Consume	integer	The execution duration. Unit: microseconds (μs).	58
Vip	string	The endpoint that is resolved from the query connection string.	100.115.XX.XX
NodeId	string	The node ID.	pi-uf6k5f6g3912i****
SqlId	string	The SQL ID.	c67649d4a7fb62c4f8c7a447c52b5b17
UseImciEngine	string	Indicates whether an In-Memory Column Index (IMCI) is used for the PolarDB for MySQL instance. true false	true
ParallelQueueTime	string	The parallel queue time for the PolarDB for MySQL instance. Unit: milliseconds.	2
ParallelDegree	string	The degree of parallelism (DOP) for the PolarDB for MySQL instance.	10
Scnt	integer	The number of requests sent from a compute node (CN) to data nodes (DNs) in a PolarDB-X 2.0 instance.	10
Rows	integer	The total number of rows updated or returned by the compute node (CN) of a PolarDB-X 2.0 instance.	10
Frows	integer	The number of rows fetched by the compute node (CN) in a PolarDB-X 2.0 instance.	10
TraceId	string	The trace ID for a PolarDB-X 2.0 instance. This is the ID of the SQL statement that was executed on a data node (DN).	14c93b7c7bf00000
PhysicRead	integer	The number of physical reads.	0
CpuTime	integer	The CPU execution time. Unit: microseconds (μs).	100
Writes	integer	The number of write operations on an ApsaraDB RDS for SQL Server instance.	10
Collection	string	This parameter is reserved.	None
TableName	string	The name of the table that the SQL statement references.	das
ConnectionId	string	The connection ID.	ld-******
Protocol	string	The protocol type.	MySQL
Params	string	The SQL parameters.	[1, "das"]
ClientIp	string	The client IP address.	10.0.0.1xx
ClientPort	integer	The client port.	3306
RowKey	string	The row key of the SQL log record.	23
AffectColumns	string	The affected columns.	["col1"]
Finish	string	Indica se a tarefa está concluída. Valores válidos: 0: A tarefa está em andamento. 1: A tarefa está concluída. Nota Se este parâmetro for 0 e o parâmetro JobId for retornado, a solicitação atual é uma solicitação assíncrona e você não pode obter os resultados retornados. Você deve usar o valor de JobId para iniciar outra solicitação. Defina o parâmetro Filters com o valor de JobId. Exemplo: `Filters=[{"Key": "JobId", "Value": "******"}]`.	1
JobId	string	O ID da tarefa assíncrona.	MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE",
  "Success": "true",
  "Data": {
    "StartTime": 1596177993000,
    "EndTime": 1608888296000,
    "TotalRecords": 1,
    "Items": {
      "SQLLogRecord": [
        {
          "Ext": "None",
          "ExecuteTime": "2023-12-07T02:15:32Z",
          "OriginTime": 1701886532000,
          "HostAddress": "11.197.XX.XX",
          "UpdateRows": 0,
          "LogicRead": 0,
          "SqlText": "select resource_id as cluster_id, tpl_name \\n\\tfrom dbfree_alert_resource_tpl_ref\\n\\twhere user_id=? and type='cluster' group by resource_id, tpl_name",
          "LockTime": 0,
          "ScanRows": 0,
          "ThreadId": 0,
          "State": "0",
          "DBName": "testdb",
          "SqlType": "select",
          "AccountName": "testname",
          "PhysicSyncRead": 0,
          "PhysicAsyncRead": 0,
          "TrxId": "200000",
          "ReturnRows": 0,
          "Consume": 58,
          "Vip": "100.115.XX.XX",
          "NodeId": "pi-uf6k5f6g3912i****",
          "SqlId": "c67649d4a7fb62c4f8c7a447c52b5b17",
          "UseImciEngine": "true",
          "ParallelQueueTime": "2",
          "ParallelDegree": "10",
          "Scnt": 10,
          "Rows": 10,
          "Frows": 10,
          "TraceId": "14c93b7c7bf00000 ",
          "PhysicRead": 0,
          "CpuTime": 100,
          "Writes": 10,
          "Collection": "None",
          "TableName": "das",
          "ConnectionId": "ld-******",
          "Protocol": "MySQL",
          "Params": "[1, \"das\"]",
          "ClientIp": "10.0.0.1xx",
          "ClientPort": 3306,
          "RowKey": "23",
          "AffectColumns": "[\"col1\"]"
        }
      ]
    },
    "Finish": "1",
    "JobId": "MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465"
  }
}

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.