DescribeAuditLogRecords - AnalyticDB: Central de Documentação do Alibaba Cloud

Consulta os logs de auditoria de SQL do cluster.

Descrição da operação

Você pode consultar os logs de auditoria de SQL apenas se a auditoria de SQL estiver ativada. Os dados de log são retidos por até 30 dias. Se você desativar e reativar a auditoria de SQL, poderá consultar apenas os logs gerados após a reativação. Os logs de auditoria de SQL não registram operações INSERT INTO VALUES, REPLACE INTO VALUES ou UPSERT INTO VALUES.\n\n- Para obter uma lista de endpoints, consulte Endpoints.

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

adb:DescribeAuditLogRecords

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	\nO ID do cluster da Data Lakehouse Edition.\n\n> Você pode chamar a operação DescribeDBClusters para consultar os IDs de todos os clusters em uma região.	amv-t4nj8619bz2w3****
RegionId	string	Sim	O ID da região.\n\n> Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis.	cn-hangzhou
StartTime	string	Não	O início do intervalo de tempo a ser consultado. O horário deve estar em UTC e no formato `yyyy-MM-ddTHH:mmZ`.\n\n> Você pode consultar os logs de auditoria de SQL apenas quando esse recurso estiver ativado. Os logs estão disponíveis para os últimos 30 dias. Se você desativar e, em seguida, reativar a auditoria de SQL, apenas os logs gerados após a reativação do recurso serão retornados.	2022-08-12T04:17Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. O horário deve estar em UTC e no formato `yyyy-MM-ddTHH:mmZ`.\n\n> - O horário de término deve ser posterior ao horário de início.\n>\n> - O intervalo de tempo não pode exceder 24 horas.	2022-08-12T17:08Z
DBName	string	Não	O nome do banco de dados no qual a instrução SQL foi executada.	adb_demo
QueryKeyword	string	Não	Uma palavra-chave usada para realizar uma pesquisa aproximada nos resultados retornados.	adb
SqlType	string	Não	O tipo da instrução SQL. Valores válidos:\n\n- DELETE\n\n- SELECT\n\n- UPDATE\n\n- INSERT INTO SELECT\n\n- ALTER\n\n- DROP\n\n- CREATE\n\n> Você pode especificar apenas um tipo por solicitação. Se esse parâmetro não for especificado, todos os tipos serão consultados por padrão.	SELECT
Succeed	string	Não	Indica se a instrução SQL foi executada com sucesso. Valores válidos:\n\n- true: A instrução SQL foi bem-sucedida.\n\n- false: A instrução SQL falhou.	true
HostAddress	string	Não	O endereço IP e o número da porta do cliente.	100.104.XX.XX:43908
OrderType	string	Não	A ordem de classificação dos resultados com base no tempo de execução. Valores válidos:\n\n- asc: ordem crescente.\n\n- desc: ordem decrescente.	asc
User	string	Não	O nome de usuário que executou a instrução SQL.	test
Order	string	Não	Especifica os campos para classificar os resultados. O valor é uma string JSON que é uma matriz de objetos. A ordem dos objetos na matriz define a prioridade de classificação. Cada objeto contém os parâmetros `Field` e `Type`. Exemplo: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`.\n\n- `Field`: o campo pelo qual classificar os resultados. Valores válidos:\n\n - HostAddress: o endereço IP do cliente.\n\n - UserName: o nome de usuário.\n\n - ExecutionStartTime: o horário de início da execução da instrução SQL.\n\n - QueryTime: a duração da execução.\n\n - PeakMemoryUsage: o uso máximo de memória da instrução SQL.\n\n - ScanRows: o número de linhas verificadas por uma tarefa que envolve uma fonte de dados.\n\n - ScanSize: a quantidade de dados verificados.\n\n - ScanTime: o tempo necessário para a verificação dos dados.\n\n - PlanningTime: o tempo necessário para gerar o plano de execução.\n\n - WallTime: o tempo total de CPU de todos os operadores em todos os nós.\n\n - ProcessID: o ID do processo.\n\n- `Type`: a ordem de classificação. Valores válidos:\n\n - Desc: ordem decrescente.\n\n - Asc: ordem crescente.	[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
PageSize	integer	Não	O tamanho da página. Valores válidos:\n\n- 10 (padrão)\n\n- 30\n\n- 50\n\n- 100	10
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.	1
ProxyUser	string	Não	Um parâmetro reservado.	无

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
TotalCount	string	O número total de registros.	6974
PageSize	string	O número de registros por página.	10
RequestId	string	O ID da solicitação.	8A564B7F-8C00-43C0-8EC5-919FBB70573
PageNumber	string	O número da página.	1
DBClusterId	string	\nO ID do cluster da Data Lakehouse Edition.	amv-t4nj8619bz2w3****
Items	array<object>	Uma lista de registros de log de auditoria.
	object	Os detalhes de um registro de log de auditoria.
HostAddress	string	O endereço IP e a porta do cliente que executou a instrução SQL.	100.104.XX.XX:43908
Succeed	string	Indica se a instrução SQL foi bem-sucedida. Valores válidos:\n\n- true: A instrução SQL foi bem-sucedida.\n\n- false: A instrução SQL falhou.	true
SQLText	string	A instrução SQL.	SELECT * FROM adb_hdfs_import_source
TotalTime	string	A duração da execução da instrução SQL em milissegundos (ms).	216
ConnId	string	O ID da conexão.	14356****
DBName	string	O nome do banco de dados no qual a instrução SQL foi executada.	adb_demo
SQLType	string	O tipo SQL.	SELECT
ExecuteTime	string	O horário de início da execução da instrução SQL. O horário está no formato `yyyy-MM-dd HH:mm:ss` e no fuso horário local.	2022-08-12 10:10:00
ExecuteTimestamp	integer	O horário de início da execução da instrução SQL, como um carimbo de data/hora em milissegundos.	1774600396584
ProcessID	string	O ID do processo.	202106081752021720161662490345362390
User	string	O nome de usuário da conta que executou a instrução SQL.	test
HasDiagnosticInfo	boolean	Especifica se a resposta contém informações de diagnóstico. Valores válidos: true : As informações de diagnóstico estão incluídas. false : As informações de diagnóstico não estão incluídas.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": "6974",
  "PageSize": "10",
  "RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "PageNumber": "1",
  "DBClusterId": "amv-t4nj8619bz2w3****",
  "Items": [
    {
      "HostAddress": "100.104.XX.XX:43908",
      "Succeed": "true",
      "SQLText": "SELECT * FROM adb_hdfs_import_source",
      "TotalTime": "216",
      "ConnId": "14356****",
      "DBName": "adb_demo",
      "SQLType": "SELECT",
      "ExecuteTime": "2022-08-12 10:10:00",
      "ExecuteTimestamp": 1774600396584,
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test",
      "HasDiagnosticInfo": true
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.