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

Consulta os detalhes de log do DAS Enterprise Edition.

Descrição da operação

Antes de chamar esta operação, certifique-se de que os seguintes pré-requisitos sejam atendidos:\n\n- Use a versão mais recente do SDK do Alibaba Cloud ou do DAS.\n- Ao usar um SDK para chamar o DAS, defina 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 resources.

*

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ó.\n\n- Para o ApsaraDB RDS for MySQL e o PolarDB for MySQL, este parâmetro se aplica apenas a instâncias da Cluster Edition. Se você não especificar este parâmetro, os detalhes de log do nó primário serão consultados por padrão.\n- Para o 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 do PolarDB-X 2.0. Valores válidos:\n\n- polarx_cn: nó de computação.\n- polarx_dn: nó de dados.	polarx_cn
Filters	array<object>	Não	A lista de condições de filtro.
	object	Não	A condição de filtro.
Key	string	Não	O parâmetro de filtro.\n\n> Para parâmetros de filtro suportados e seus valores válidos, consulte Descrições suplementares dos parâmetros de solicitação.	keyWords
Value	string	Não	O valor do parâmetro de filtro.	select
StartTime	integer	Sim	A hora de início. O valor é um timestamp UNIX em milissegundos.	1596177993000
EndTime	integer	Sim	A hora de término. O valor é um timestamp UNIX em milissegundos.	1608888296000
PageNo	integer	Não	O número da página para paginação. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de entradas por página. Valor máximo: 100. Valor padrão: 10.	10

Os parâmetros e valores suportados por Key são os seguintes:

KeyWords: As palavras-chave. Separe várias palavras-chave com espaços.
LogicalOperator: O operador lógico entre palavras-chave. Valores válidos: and e or.
AccountName: O nome de usuário. 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 da execução, em microssegundos.
MinConsume: A duração mínima da 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 instrução SQL. Valores válidos: select, update, insert e delete.
State: O resultado da execução. Valores válidos: 0 (sucesso) e 1 (falha).
ThreadId: O ID do thread.
SortKey: O nome da coluna pela qual ordenar. Valores válidos: ScanRows (número de linhas verificadas), UpdateRows (número de linhas atualizadas), Consume (duração da execução), ExecuteTime (horário de execução), ReturnRows (número de linhas retornadas), LockTime (tempo de espera de bloqueio), Frows (número de linhas buscadas pelo nó de computação do PolarDB-X 2.0), Scnt (número de solicitações para o nó de dados a partir do nó de computação do PolarDB-X 2.0), CpuTime (tempo de execução da CPU) e PhysicalRead (leituras físicas).
SortMethod: A ordem de classificação. Valores válidos: DESC (ordem decrescente) e ASC (ordem crescente). Valor padrão: DESC.
TraceId: O ID de rastreamento da instância do PolarDB-X 2.0.
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 para o nó de dados (DN) a partir do nó de computação (CN) do PolarDB-X 2.0.
MaxScnt: O número máximo de solicitações para o nó de dados (DN) a partir do nó de computação (CN) do PolarDB-X 2.0.
TrxId: O ID da transação.
Fail: O código de erro.
SqlId: O ID SQL.
JobId: O ID da tarefa assíncrona usada para consultar posteriormente os resultados retornados.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O nó raiz.
Code	string	O código de status HTTP retornado.	200
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, como um código 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. O valor é um timestamp UNIX em milissegundos.	1596177993000
EndTime	integer	A hora de término. O valor é um timestamp UNIX em milissegundos.	1608888296000
TotalRecords	integer	O número total de registros.	1
Items	object	Os dados da lista.
SQLLogRecord	array<object>	Os dados de log SQL.
	object	Os dados de log SQL.
Ext	string	O campo de informações estendidas. Este é um parâmetro reservado.	None
ExecuteTime	string	O horário de execução no formato UTC: `yyyy-MM-ddTHH:mm:ssZ`.	2023-12-07T02:15:32Z
OriginTime	integer	O timestamp de execução. O valor é um timestamp UNIX em milissegundos.	1701886532000
HostAddress	string	O endereço IP do cliente.	11.197.XX.XX
UpdateRows	integer	O número de linhas atualizadas.	0
LogicRead	integer	O número de leituras lógicas.	0
SqlText	string	A instrução SQL.	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	O tempo de espera de bloqueio em milissegundos.	0
ScanRows	integer	O número de linhas verificadas.	0
ThreadId	integer	O ID do thread.	None
State	string	O status de execução. Valores válidos: 0: A execução foi bem-sucedida. 1: A execução falhou.	0
DBName	string	O nome do banco de dados.	testdb
SqlType	string	O tipo da instrução SQL.	select
AccountName	string	A conta do banco de dados.	testname
PhysicSyncRead	integer	O número de leituras síncronas físicas.	0
PhysicAsyncRead	integer	O número de leituras assíncronas físicas.	0
TrxId	string	O ID da transação.	200000
ReturnRows	integer	O número de linhas retornadas.	0
Consume	integer	A duração da execução em microssegundos.	58
Vip	string	O endereço do endpoint resolvido da conexão de consulta.	100.115.XX.XX
NodeId	string	O ID do nó.	pi-uf6k5f6g3912i****
SqlId	string	O ID SQL.	c67649d4a7fb62c4f8c7a447c52b5b17
UseImciEngine	string	Indica se a instância do PolarDB for MySQL usa IMCI. Valores válidos: true: Sim. false: Não.	true
ParallelQueueTime	string	O grau de paralelismo da instância do PolarDB for MySQL.	2
ParallelDegree	string	O tempo de fila paralela da instância do PolarDB for MySQL em milissegundos.	10
Scnt	integer	O número de solicitações do nó de computação (CN) para o nó de dados (DN) no PolarDB-X 2.0.	10
Rows	integer	O número total de linhas atualizadas ou retornadas pelo nó de computação da instância do PolarDB-X 2.0.	10
Frows	integer	O número de linhas buscadas pelo nó de computação (CN) no PolarDB-X 2.0.	10
TraceId	string	O ID de rastreamento no PolarDB-X 2.0, que é o ID de execução da instrução SQL no nó de dados.	14c93b7c7bf00000
PhysicRead	integer	O número de leituras físicas.	0
CpuTime	integer	O tempo de execução da CPU em microssegundos.	100
Writes	integer	O número de gravações para o mecanismo ApsaraDB RDS for SQL Server.	10
Collection	string	O parâmetro reservado.	None
TableName	string	O nome da tabela no registro de log SQL.	das
ConnectionId	string	O ID da conexão do registro de log SQL.	ld-******
Protocol	string	O tipo de protocolo do registro de log SQL.	MySQL
Params	string	Os parâmetros do registro de log SQL.	[1, "das"]
ClientIp	string	O endereço IP do cliente no registro de log SQL. O endereço IP do cliente no registro de log SQL.	10.0.0.1xx
ClientPort	integer	O número da porta do cliente.	3306
RowKey	string	A chave de linha do registro de log SQL.	23
AffectColumns	string	As colunas afetadas.	["col1"]
Finish	string	Indica se a tarefa foi concluída. Valores válidos: 0: Não concluída. 1: Concluída. Nota Se Finish for 0 e o campo JobId estiver incluído, a solicitação atual é uma solicitação assíncrona e o resultado não pode ser obtido diretamente. Você deve consultar o resultado com base em JobId. Ao consultar o resultado, use JobId como valor de entrada para Filters. 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.	Os parâmetros da solicitação são inválidos.
403	NoPermission	You are not authorized to do this action.	Você não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.