Todos os produtos
Search
Central de documentação

:DescribeAuditRecords

Última atualização: Jul 08, 2026

Consulta entradas nos logs de auditoria de uma instância do ApsaraDB for MongoDB.

  • Ao chamar esta operação, verifique se o recurso de log de auditoria da instância está ativado. Caso contrário, a operação retornará um log de auditoria vazio.

  • Esta operação aplica-se apenas a instâncias de disco local de uso geral e de disco local dedicado.

  • O limite de chamadas para esta operação é de 30 vezes por minuto. Para chamá-la com maior frequência, use um Logstore. Para mais informações, consulte Gerencie um Logstore.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

ParâmetroTipoObrigatórioExemploDescrição
ActionStringSimDescribeAuditRecords

A operação a ser executada. Defina o valor como DescribeAuditRecords.

RegionIdStringNãocn-hangzhou

ID da região da instância. Chame a operação DescribeDBInstanceAttribute para consultar esse ID.

DBInstanceIdStringSimdds-bp12c5b040dc****

ID da instância.

Nota Se definir este parâmetro como o ID de uma instância de cluster fragmentado, especifique também o parâmetro NodeId.
NodeIdStringNãod-bp128a003436****

ID do nó mongos ou shard cujos logs de auditoria serão consultados na instância. Este parâmetro é obrigatório para instâncias de cluster fragmentado.

Nota Este parâmetro é válido somente quando DBInstanceId corresponde ao ID de uma instância de cluster fragmentado.
StartTimeStringSim2019-03-13T12:11:14Z

Início do intervalo de tempo da consulta. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ, em UTC.

EndTimeStringSim2019-03-13T13:11:14Z

Fim do intervalo de tempo da consulta do log de auditoria. O horário final deve ser posterior ao inicial. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ, em UTC.

Nota O horário final deve estar dentro de 24 horas após o horário inicial. Caso contrário, a consulta falhará.
DatabaseStringNãotestdatabase

Nome do banco de dados a ser consultado. Por padrão, todos os bancos de dados são consultados.

UserStringNãoroot

Usuário do banco de dados. Se não especificar este parâmetro, a operação retornará registros de todos os usuários.

FormStringNãoStream

Formato do log de auditoria retornado pela operação. Valores válidos:

  • File: aciona a geração de logs de auditoria. Se definido como File, apenas parâmetros comuns serão retornados.
  • Stream: retorna fluxos de dados.

Valor padrão: Stream.

QueryKeywordsStringNãoslow

Palavras-chave usadas nas consultas. Separe múltiplas palavras-chave com espaços. O limite máximo é de 10 palavras-chave.

PageSizeIntegerNão30

Número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.

PageNumberIntegerNão1

Número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.

OrderTypeStringNãoasc

Ordem cronológica de classificação das entradas de log retornadas. Valores válidos:

  • asc: classifica as entradas de log por tempo em ordem crescente.
  • desc: classifica as entradas de log por tempo em ordem decrescente.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

TotalRecordCount

Integer

40

Número total de entradas.

PageRecordCount

Integer

30

Número máximo de entradas na página atual.

RequestId

String

3278BEB8-503B-4E46-8F7E-D26E040C9769

ID da solicitação.

PageNumber

Integer

1

Número da página retornada.

Items

Array of SQLRecord

Matriz composta pelas informações das entradas do log de auditoria.

SQLRecord

HostAddress

String

11.xxx.xxx.xxx

Endereço IP do cliente.

TableName

String

C1

Nome da coleção.

ReturnRowCounts

Long

2

Quantidade de entradas de log de auditoria SQL retornadas.

DBName

String

test123

Nome do banco de dados.

ExecuteTime

String

2019-03-11T03:30:27Z

Momento de execução da instrução. O horário segue o formato aaaa-MM-dd T HH:mm:ss Z e é exibido em UTC.

ThreadID

String

140682188297984

ID da thread registrada na entrada do log de auditoria SQL.

TotalExecutionTimes

Long

700

Duração da execução da instrução. Unidade: microssegundos.

Syntax

String

{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }

Instrução executada.

AccountName

String

root

Conta do banco de dados.

Exemplos

Exemplos de solicitações

http(s)://mongodb.aliyuncs.com/?Action=DescribeAuditRecords
&StartTime=2019-03-13T12:11:14Z
&EndTime=2019-03-13T13:11:14Z
&DBInstanceId=dds-bp12c5b040dc****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeAuditRecordsResponse>
    <Items>
        <SQLRecord>
            <TotalExecutionTimes>703</TotalExecutionTimes>
            <Syntax>{ &quot;atype&quot; : &quot;command&quot;, &quot;param&quot; : { &quot;command&quot; : &quot;find&quot;, &quot;ns&quot; : &quot;123.test1&quot;, &quot;args&quot; : { &quot;find&quot; : &quot;test1&quot;, &quot;filter&quot; : { &quot;x&quot; : 1, &quot;y&quot; : 2 }, &quot;shardVersion&quot; : [ { &quot;$timestamp&quot; : { &quot;t&quot; : 0, &quot;i&quot; : 0 } }, { &quot;$oid&quot; : &quot;000000000000000000000000&quot; } ], &quot;$clusterTime&quot; : { &quot;clusterTime&quot; : { &quot;$timestamp&quot; : { &quot;t&quot; : 1552275017, &quot;i&quot; : 2 } }, &quot;signature&quot; : { &quot;hash&quot; : { &quot;$binary&quot; : &quot;9qfygDs61fKCvdXJqjq+f0zML0E=&quot;, &quot;$type&quot; : &quot;00&quot; }, &quot;keyId&quot; : { &quot;$numberLong&quot; : &quot;6666955498811555841&quot; } } }, &quot;$client&quot; : { &quot;application&quot; : { &quot;name&quot; : &quot;MongoDB Shell&quot; }, &quot;driver&quot; : { &quot;name&quot; : &quot;MongoDB Internal Client&quot;, &quot;version&quot; : &quot;3.4.10&quot; }, &quot;os&quot; : { &quot;type&quot; : &quot;Linux&quot;, &quot;name&quot; : &quot;Ubuntu&quot;, &quot;architecture&quot; : &quot;x86_64&quot;, &quot;version&quot; : &quot;16.04&quot; }, &quot;mongos&quot; : { &quot;host&quot; : &quot;rxxxxxx.cloud.cm10:3074&quot;, &quot;client&quot; : &quot;47.xxx.xxx.xx:53854&quot;, &quot;version&quot; : &quot;4.0.0&quot; } }, &quot;$configServerState&quot; : { &quot;opTime&quot; : { &quot;ts&quot; : { &quot;$timestamp&quot; : { &quot;t&quot; : 1552275017, &quot;i&quot; : 2 } }, &quot;t&quot; : { &quot;$numberLong&quot; : &quot;3&quot; } } }, &quot;$db&quot; : &quot;123&quot; } }, &quot;result&quot;: &quot;OK&quot; }</Syntax>
            <HostAddress>11.xxx.xxx.xx</HostAddress>
            <ExecuteTime>2019-03-11T03:30:27Z</ExecuteTime>
            <ThreadID>139xxxxxxxx</ThreadID>
            <AccountName>__system;</AccountName>
            <DBName>local;</DBName>
        </SQLRecord>
        <SQLRecord>
            <TotalExecutionTimes>0</TotalExecutionTimes>
            <Syntax>{ &quot;atype&quot; : &quot;createIndex&quot;, &quot;param&quot; : { &quot;ns&quot; : &quot;123.test1&quot;, &quot;indexName&quot; : &quot;y_1&quot;, &quot;indexSpec&quot; : { &quot;v&quot; : 2, &quot;key&quot; : { &quot;y&quot; : 1 }, &quot;name&quot; : &quot;y_1&quot;, &quot;ns&quot; : &quot;123.test1&quot; } }, &quot;result&quot;: &quot;OK&quot; }</Syntax>
            <HostAddress></HostAddress>
            <ExecuteTime>2019-03-11T03:30:06Z</ExecuteTime>
            <ThreadID>140xxxxxxxx</ThreadID>
            <AccountName>__system;</AccountName>
            <DBName>local;</DBName>
        </SQLRecord>
    </Items>
    <PageNumber>1</PageNumber>
    <TotalRecordCount>2</TotalRecordCount>
    <RequestId>3278BEB8-503B-4E46-8F7E-D26E040C9769</RequestId>
    <PageRecordCount>30</PageRecordCount>
</DescribeAuditRecordsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Items" : {
    "SQLRecord" : [ {
      "TotalExecutionTimes" : 703,
      "Syntax" : "{ \"atype\" : \"command\", \"param\" : { \"command\" : \"find\", \"ns\" : \"123.test1\", \"args\" : { \"find\" : \"test1\", \"filter\" : { \"x\" : 1, \"y\" : 2 }, \"shardVersion\" : [ { \"$timestamp\" : { \"t\" : 0, \"i\" : 0 } }, { \"$oid\" : \"000000000000000000000000\" } ], \"$clusterTime\" : { \"clusterTime\" : { \"$timestamp\" : { \"t\" : 1552275017, \"i\" : 2 } }, \"signature\" : { \"hash\" : { \"$binary\" : \"9qfygDs61fKCvdXJqjq+f0zML0E=\", \"$type\" : \"00\" }, \"keyId\" : { \"$numberLong\" : \"6666955498811555841\" } } }, \"$client\" : { \"application\" : { \"name\" : \"MongoDB Shell\" }, \"driver\" : { \"name\" : \"MongoDB Internal Client\", \"version\" : \"3.4.10\" }, \"os\" : { \"type\" : \"Linux\", \"name\" : \"Ubuntu\", \"architecture\" : \"x86_64\", \"version\" : \"16.04\" }, \"mongos\" : { \"host\" : \"rxxxxxx.cloud.cm10:3074\", \"client\" : \"47.xxx.xxx.xx:53854\", \"version\" : \"4.0.0\" } }, \"$configServerState\" : { \"opTime\" : { \"ts\" : { \"$timestamp\" : { \"t\" : 1552275017, \"i\" : 2 } }, \"t\" : { \"$numberLong\" : \"3\" } } }, \"$db\" : \"123\" } }, \"result\": \"OK\" }",
      "HostAddress" : "11.xxx.xxx.xxx",
      "ExecuteTime" : "2019-03-11T03:30:27Z",
      "ThreadID" : "139xxxxxxxx",
      "AccountName" : "__system;",
      "DBName" : "local;"
    }, {
      "TotalExecutionTimes" : 0,
      "Syntax" : "{ \"atype\" : \"createIndex\", \"param\" : { \"ns\" : \"123.test1\", \"indexName\" : \"y_1\", \"indexSpec\" : { \"v\" : 2, \"key\" : { \"y\" : 1 }, \"name\" : \"y_1\", \"ns\" : \"123.test1\" } }, \"result\": \"OK\" }",
      "HostAddress" : "",
      "ExecuteTime" : "2019-03-11T03:30:06Z",
      "ThreadID" : "140xxxxxxxx",
      "AccountName" : "__system;",
      "DBName" : "local;"
    } ]
  },
  "PageNumber" : 1,
  "TotalRecordCount" : 2,
  "RequestId" : "3278BEB8-503B-4E46-8F7E-D26E040C9769",
  "PageRecordCount" : 30
}

Códigos de erro

HttpCode

Códigos de erro

Mensagem de erro

Descrição

400

InvalidEndTime.Format

Specified end time is not valid.

Mensagem de erro retornada porque o parâmetro EndTime especificado é inválido. Especifique o horário no formato aaaa-MM-ddTHH:mmZ, em UTC. O horário final deve ser posterior ao horário inicial.

Para obter uma lista de códigos de erro, visite o API Error Center.