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

Consulta a lista de logs de alertas de auditoria de dados para facilitar a pesquisa e o processamento de alertas.

Descrição da operação

Para usar esta operação, você deve atender aos seguintes pré-requisitos:

Ao usar o SDK do Alibaba Cloud ou do DAS, use a versão mais recente.
Ao usar o SDK para chamar o DAS, especifique 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:DescribeAuditLogs

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang	string	Não	O tipo de idioma das mensagens de solicitação e resposta. Valor padrão: zh_cn. Valores válidos: zh_cn: Chinês. en_us: Inglês.	zh-CN
UserName	string	Não	O nome de usuário.	admin
ClientIp	string	Não	O endereço IP do cliente que envia a solicitação.	11.26.118.7
ClientUa	string	Não	O tipo de cliente.	mysql
InstanceName	string	Não	O nome da instância do ativo.	rm-t4ni1cezz5y3xxxx
DatabaseName	string	Não	O nome do banco de dados.	TestDB
StartTime	integer	Não	A hora de início dos logs de alertas. Unidade: milissegundos.	1608888296000
EndTime	integer	Não	A hora de término dos logs de alertas. O valor é um carimbo de data/hora UNIX em milissegundos.	15682887991222
ProductCode	string	Não	O nome do produto ao qual o ativo de dados pertence. Os valores válidos incluem RDS, PolarDB e PolarDB-X 2.0.	RDS
ProductId	integer	Não	O ID do produto ao qual o objeto de dados pertence. Valores válidos: 3: ADB-MYSQL 5: RDS 7: PolarDB-X 8: PolarDB 9: ADB-PG 11: MongoDB 25: Redis	5
SqlText	string	Não	O conteúdo da instrução SQL.	SELECT * FROM test where name = 'das'
ExecuteTimeRange	string	Não	O intervalo de tempo de execução.	in[1000 2000]
EffectRowRange	string	Não	O intervalo de linhas afetadas.	in[1 33]
RuleName	string	Não	O nome da regra de auditoria.	test_rule
OperateType	string	Não	O tipo de operação.	Insert
OssObjectKey	string	Não	A chave do objeto OSS.	N.A
AsyncRequestId	string	Não	O ID da solicitação.	2c548e83-1473-4fda-b3dc-5a189074ead5
PageSize	integer	Não	O número máximo de entradas por página. Valor padrão: 10.	30
CurrentPage	integer	Não	O número da página atual.	3
RuleCategory	string	Não	O tipo de regra.	10
LoadWhiteList	boolean	Não	Especifica se o status da lista de permissões deve ser carregado.	false
IpType	string	Não	O tipo de rede. Valores válidos: default: Serviços não Alibaba Cloud. Este é o valor padrão. aliyun: Serviços Alibaba Cloud.	aliyun
LogSource	string	Não	A fonte de dados.	SLOW_SQL
RuleAggQuery	boolean	Não	Especifica se uma consulta agregada deve ser realizada.	true
RuleId	string	Não	O ID da regra.	867028
LogQueryOpJson	string	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AsyncRequestId	string	O ID da solicitação.	3926fba5-1774-44f4-af2d-ac7b33e86c3b
CurrentPage	integer	O número da página atual.	1
Items	array<object>	Os endereços IP dos clientes nos registros de log SQL.
	object	A leitura assíncrona física.
ClientIp	string	O endereço IP do cliente na consulta.	100.104.16.251
ClientPort	string	O número da porta do cliente na consulta.	53815
ClientUa	string	O tipo de cliente.	mysql
ColumnName	string	O nome da coluna.	ds
CreationTime	integer	A hora do alerta. Unidade: milissegundos.	1536751124000
DatabaseName	string	O nome do banco de dados.	chngc_b2b_migration_sh
EffectRow	integer	O número de linhas afetadas.	10
ExecuteStatus	integer	O status de execução. Valores válidos: 0: Falha. 1: Sucesso.	1
ExecuteTime	integer	A duração da execução. Unidade: milissegundos.	1751870592000
Id	integer	O ID da chave primária.	1
InWhiteList	boolean	Indica se o alerta está na lista de permissões.	True
InstanceAuditStatus	string	O status de auditoria da instância.	2
InstanceDescription	string	A descrição da instância do ativo de dados.	instance dscription
InstanceName	string	O alias da instância.	test-instance-003
IpType	string	O tipo de rede. Valores válidos: default: Serviços não Alibaba Cloud. Este é o valor padrão. aliyun: Serviços Alibaba Cloud.	aliyun
LogSource	string	A fonte de dados.	SLOW_SQL
LogTime	integer	A hora de execução do log. O valor é um carimbo de data/hora UNIX em milissegundos.	1751870592000
Message	string	O conteúdo bruto do log.	success
OperateType	string	O tipo de operação.	Drop
OssObjectKey	string	A chave do objeto OSS.	N.A
PackageName	string	O nome do pacote MaxCompute.	test01
ProductCode	string	O nome do produto ao qual o ativo de dados pertence. Os valores válidos incluem RDS, PolarDB e PolarDB-X 2.0.	RDS
ProductId	integer	O ID do produto ao qual o objeto de dados pertence. Valores válidos: 3: ADB-MYSQL 5: RDS 7: PolarDB-X 8: PolarDB 9: ADB-PG 11: MongoDB 25: Redis	5
RuleCategory	string	O tipo de regra.	10
RuleId	string	O ID da regra de auditoria.	9953411
RuleName	string	O nome da regra de auditoria.	name
SqlText	string	A instrução SQL.	select * from test03
TableName	string	O nome da tabela usada na consulta.	it_table
UserId	string	O UID do usuário.	19********94
UserName	string	O nome de usuário.	admin
WarnLevel	string	O nível de risco. Valores válidos: 1: Baixo risco. 2: Risco médio. 3: Alto risco.	1
WarnLevelName	string	O nome do nível de risco. Valores válidos: Baixo risco. Risco médio. Alto risco.	1
PageSize	integer	O número de entradas por página na consulta paginada.	10
RequestId	string	O ID da solicitação.	A7021857-AFD9-5AD6-979D-AA7DFC5AFADF
TotalCount	integer	O número total de registros. Este parâmetro é válido apenas para o mecanismo Redis.	12

Exemplos

Resposta de sucesso

JSON formato

{
  "AsyncRequestId": "3926fba5-1774-44f4-af2d-ac7b33e86c3b",
  "CurrentPage": 1,
  "Items": [
    {
      "ClientIp": "100.104.16.251",
      "ClientPort": "53815",
      "ClientUa": "mysql",
      "ColumnName": "ds",
      "CreationTime": 1536751124000,
      "DatabaseName": "chngc_b2b_migration_sh",
      "EffectRow": 10,
      "ExecuteStatus": 1,
      "ExecuteTime": 1751870592000,
      "Id": 1,
      "InWhiteList": true,
      "InstanceAuditStatus": "2",
      "InstanceDescription": "descrição da instância",
      "InstanceName": "test-instance-003",
      "IpType": "aliyun",
      "LogSource": "SLOW_SQL",
      "LogTime": 1751870592000,
      "Message": "sucesso",
      "OperateType": "Drop",
      "OssObjectKey": "N.A",
      "PackageName": "test01",
      "ProductCode": "RDS",
      "ProductId": 5,
      "RuleCategory": "10",
      "RuleId": "9953411",
      "RuleName": "nome",
      "SqlText": "select * from test03",
      "TableName": "it_table",
      "UserId": "19********94",
      "UserName": "admin",
      "WarnLevel": "1",
      "WarnLevelName": "1"
    }
  ],
  "PageSize": 10,
  "RequestId": "A7021857-AFD9-5AD6-979D-AA7DFC5AFADF",
  "TotalCount": 12
}

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.