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

Consulta as entradas de log de auditoria de uma instância do MongoDB.

Descrição da operação

Ao chamar esta operação, certifique-se de que o recurso de log de auditoria da instância esteja ativado. Caso contrário, a operação retornará um log de auditoria vazio.
Esta operação é aplicável apenas a instâncias de disco local de uso geral e disco local dedicado.
Você pode chamar esta operação até 30 vezes por minuto. Para chamar esta operação com uma frequência maior, 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ê definir este parâmetro como o ID de uma instância de cluster sharded, também deverá especificar o parâmetro NodeId.	dds-bp12c5b040dc****
NodeId	string	Não	O ID de um nó Mongos ou de um nó shard na instância de cluster sharded. Nota Este parâmetro está disponível apenas quando DBInstanceId for definido como o ID de uma instância de cluster sharded.	d-bp128a003436****
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.	2019-03-13T12:11:14Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. A hora de término deve ser posterior à hora de início. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota O intervalo de tempo entre a hora de início e a hora de término não pode exceder 24 horas. Caso contrário, a operação falhará.	2019-03-13T13:11:14Z
Database	string	Não	O nome do banco de dados. Por padrão, todos os bancos de dados são consultados.	database****
User	string	Não	A conta do banco de dados. Por padrão, todas as contas são consultadas.	test
Form	string	Não	O formato 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 como File, apenas os parâmetros comuns serão retornados. Stream (padrão): Retorna um fluxo de dados. Nota O parâmetro File foi descontinuado.	Stream
QueryKeywords	string	Não	As palavras-chave para a consulta. Você pode especificar até 10 palavras-chave. Separe várias palavras-chave com espaços.	slow
LogicalOperator	string	Não	O operador lógico para a pesquisa de palavras-chave. O valor padrão é and.	and
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 (padrão), 50 e 100.	30
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser maior que 0 e não deve exceder o valor máximo do tipo de dados inteiro. Valor padrão: 1.	1
OrderType	string	Não	A ordem na qual classificar as entradas de log de auditoria retornadas por hora. Valores válidos: asc: Classifica as entradas em ordem crescente. desc: Classifica as entradas em ordem decrescente.	asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	integer	O número total de entradas.	40
PageRecordCount	integer	O número de entradas 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	Os detalhes de uma entrada de log de auditoria.
HostAddress	string	The IP address of the client.	11.xxx.xxx.xxx
TableName	string	The name of the MongoDB collection.	C1
ReturnRowCounts	integer	The number of returned rows.	2
DBName	string	The database name.	test123
ExecuteTime	string	The time when the statement was executed. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2019-03-11T03:30:27Z
ThreadID	string	The thread ID.	140682188297984
TotalExecutionTimes	integer	The execution time, in microseconds.	700
Syntax	string	The executed statement.	{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }
AccountName	string	The name of the database account.	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.	The specified start time is invalid.
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.
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.