DescribeAuditRecords - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta os logs de auditoria de uma instância Tair (compatível com Redis OSS).

Descrição da operação

Antes de chamar esta operação, você deve ativar o recurso de log de auditoria para a instância. Para mais informações, consulte ModifyAuditLogConfig.

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

kvstore:DescribeAuditRecords

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	r-bp1zxszhcgatnx****
NodeId	string	Não	O ID do nó na instância. Você pode definir este parâmetro para consultar os dados de monitoramento de um nó especificado. Nota Este parâmetro está disponível apenas para instâncias de divisão de leitura/escrita e cluster. Você pode chamar a operação DescribeLogicInstanceTopology para consultar os IDs dos nós.	r-bp1zxszhcgatnx****-db-0
AccountName	string	Não	O nome de usuário da conta. Se você não especificar este parâmetro, todas as contas da instância serão consultadas.	demo
DatabaseName	string	Não	O nome do banco de dados na instância. Se você não especificar este parâmetro, todos os bancos de dados serão consultados. Valores válidos: 0 a 255. 0 especifica o banco de dados 0.	0
QueryKeywords	string	Não	A palavra-chave com base na qual os logs de auditoria são consultados. Você pode especificar um comando como palavra-chave para consultar logs. Por padrão, todos os comandos são consultados. Nota Você pode especificar apenas uma única palavra-chave em cada chamada.	maxclients
HostAddress	string	Não	O endereço IP do cliente. Se você não especificar este parâmetro, esta chamada se aplica a todos os clientes.	127.0.0.1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página.	30
PageNumber	integer	Não	O número da página a ser retornada.	1
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2019-03-24T12:10:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota Recomendamos que você especifique um intervalo de tempo de 10 minutos ou menos, pois os logs de auditoria contêm um grande número de entradas. Não especifique um intervalo de tempo superior a um dia.	2019-03-25T12:10:00Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	O horário de término da consulta.	2019-03-25T12:10:00Z
StartTime	string	O horário de início da consulta.	2019-03-24T12:10:00Z
RequestId	string	O ID da solicitação.	9F5EB478-824E-4AC4-8D2B-58F31A02****
InstanceName	string	O nome da instância.	r-bp1zxszhcgatnx****
TotalRecordCount	integer	O número total de entradas retornadas.	22222
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número máximo de entradas retornadas por página.	30
Items	object
SQL	array<object>	A coleção de entradas de log de auditoria retornadas.
	object
HostAddress	string	The IP address of the client.	127.0.0.1
SQLText	string	The command that was run.	CONFIG GET maxmemory
DatabaseName	string	The database name.	demo
SQLType	string	The type of the command.	non_read_write
ExecuteTime	string	The time when the command was run.	2019-03-25T03:22:08Z
TotalExecutionTimes	string	The amount of time consumed to run the command.	0
NodeId	string	The ID of the node. Nota A specific node ID is returned only if the instance uses the cluster or read/write splitting architecture.	r-bp1zxszhcgatnx****-db-0
AccountName	string	The username of the account.	demo
IPAddress	string	The IP address of the instance.	192.16.100.***

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2019-03-25T12:10:00Z",
  "StartTime": "2019-03-24T12:10:00Z",
  "RequestId": "9F5EB478-824E-4AC4-8D2B-58F31A02****",
  "InstanceName": "r-bp1zxszhcgatnx****",
  "TotalRecordCount": 22222,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": {
    "SQL": [
      {
        "HostAddress": "127.0.0.1",
        "SQLText": "CONFIG GET maxmemory",
        "DatabaseName": "demo",
        "SQLType": "non_read_write",
        "ExecuteTime": "2019-03-25T03:22:08Z",
        "TotalExecutionTimes": "0",
        "NodeId": "r-bp1zxszhcgatnx****-db-0",
        "AccountName": "demo",
        "IPAddress": "192.16.100.***"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IncorrectDBInstance.NotSupported	This instance do not support log audit.	This instance does not support audit log related services
400	InvalidEndTime.Invalid	pecified end time is before this service active time.
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.
400	InvalidQueryTime.Format	Specified query time is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.