DescribeAuditRecords - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta os logs de auditoria de uma instância do MongoDB.

Descrição da operação

O recurso de log de auditoria deve estar ativado para a instância antes de você chamar esta operação. Caso contrário, o conteúdo do log de auditoria retornado estará vazio.
Esta operação se aplica a instâncias dos tipos de especificação Disco local de uso geral e Disco local dedicado.
Esta operação pode ser chamada até 30 vezes por minuto. As chamadas que excederem esse limite serão limitadas. Não chame esta operação com alta frequência. Se forem necessárias chamadas de alta frequência, use um Logstore. Para mais informações, consulte Gerenciar um Logstore.

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

dds:DescribeAuditRecords

get

*dbinstance.

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Nota Se você especificar um ID de instância de cluster sharded para este parâmetro, também deverá especificar o parâmetro NodeId.	dds-bp12c5b040dc****
NodeId	string	Não	O ID da instância de um nó mongos ou nó shard na instância de cluster sharded. Nota Este parâmetro está disponível apenas quando DBInstanceId está definido como o ID da instância de um cluster sharded.	d-bp128a003436****
StartTime	string	Sim	A hora de início da consulta. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.	2019-03-13T12:11:14Z
EndTime	string	Sim	A hora de término da consulta. A hora de término deve ser posterior à hora de início. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota O intervalo de tempo entre a hora de término e a hora de início não pode exceder 24 horas. Se o intervalo de tempo exceder 24 horas, a chamada falhará.	2019-03-13T13:11:14Z
Database	string	Não	O nome do banco de dados. O valor padrão é todos os bancos de dados.	database****
User	string	Não	A conta do banco de dados. O valor padrão é todas as contas.	test
Form	string	Não	O formato de exibição dos registros de auditoria retornados. Valores válidos: File: Aciona a geração de um arquivo de log de auditoria. Se você definir este parâmetro com este valor, apenas os parâmetros comuns serão retornados. Stream (padrão): Retorna um fluxo de dados. Nota O valor File está obsoleto. Valores válidos: Stream : Retorna um fluxo de dados. File : Gera um arquivo de log de auditoria.	Stream
QueryKeywords	string	Não	As palavras-chave a serem consultadas. Separe várias palavras-chave com espaços. Você pode especificar no máximo 10 palavras-chave.	slow
LogicalOperator	string	Não	O operador lógico para pesquisa de palavras-chave. O valor padrão é and. Valores válidos: or : Corresponde a qualquer palavra-chave. and : Corresponde a todas as palavras-chave.	and
PageSize	integer	Não	O número de registros por página. Valores válidos: 30 (padrão), 50 e 100.	30
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo Integer. Valor padrão: 1.	1
OrderType	string	Não	A ordem em que os logs lentos consultados são classificados por hora. Valores válidos: asc: classifica os resultados em ordem crescente por hora. desc: classifica os resultados em ordem decrescente por hora. Valores válidos: asc : Classifica os resultados em ordem crescente por hora. desc : Classifica os resultados em ordem decrescente por hora.	asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O número total de registros.
TotalRecordCount	integer	O número total de registros.	40
PageRecordCount	integer	O número máximo de registros na página atual.	30
RequestId	string	O ID da solicitação.	3278BEB8-503B-4E46-8F7E-D26E040C9769
PageNumber	integer	O número da página.	1
Items	object
SQLRecord	array<object>	A lista de detalhes do log de auditoria.
	object	As informações da instância.
HostAddress	string	O endereço IP do cliente.	11.xxx.xxx.xxx
TableName	string	O nome da coleção do MongoDB.	C1
ReturnRowCounts	integer	O número de registros retornados.	2
DBName	string	O nome do banco de dados.	test123
ExecuteTime	string	A hora em que a instrução foi executada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ. A hora está em UTC.	2019-03-11T03:30:27Z
ThreadID	string	O ID do thread.	140682188297984
TotalExecutionTimes	integer	A duração da execução, em microssegundos.	700
Syntax	string	A instrução executada.	{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }
AccountName	string	O nome da conta do banco de dados.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 40,
  "PageRecordCount": 30,
  "RequestId": "3278BEB8-503B-4E46-8F7E-D26E040C9769",
  "PageNumber": 1,
  "Items": {
    "SQLRecord": [
      {
        "HostAddress": "11.xxx.xxx.xxx",
        "TableName": "C1",
        "ReturnRowCounts": 2,
        "DBName": "test123",
        "ExecuteTime": "2019-03-11T03:30:27Z",
        "ThreadID": "140682188297984",
        "TotalExecutionTimes": 700,
        "Syntax": "{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }",
        "AccountName": "test"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Format	Specified start time is not valid.	A hora de início especificada é inválida.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidEndTime.Invalid	Specified end time is before this service active time.
400	InvalidParameterCombination	The end time must be greater than the start time.	A hora de término deve ser posterior à hora de início.
400	InvalidQueryKeyword.Format	Specified Query Keyword is not valid.
400	InvalidDatabase.Format	Specified Database is not valid.
400	InvalidQueryTime.Format	Specified query time is not valid.
403	IncorrectSQLLogActiveStatus	Current DB instance SQL log active status does not support this operation.
403	LogApiFrequencyExceeded	Exceeding the allowed frequency of log api.
403	ConcurrentTaskExceeded	Concurrent task exceeding the allowed amount.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.