文档

DescribeAuditRecords - 查询实例的审计日志

查询MongoDB实例的审计日志。

接口说明

  • 调用本接口时,实例的审计日志须处于开通状态,否则返回的审计日志内容为空。
  • 本接口适用于规格类型为通用型本地盘版独享型本地盘版实例。
  • 本接口限制每分钟调用 30 次,如超过这个限制会被限流,请勿高频调用。如需高频调用,请使用 Logstore,详情请参见管理 Logstore

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:DescribeAuditRecordsRead
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。
dds-bp12c5b040dc****
NodeIdstring

分片集群实例中 Mongos 节点 ID 或 Shard 节点 ID。

说明 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。
d-bp128a003436****
StartTimestring

查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-03-13T12:11:14Z
EndTimestring

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 查询结束时间距查询开始时间不得超过 24 个小时,超过则调用失败。
2019-03-13T13:11:14Z
Databasestring

数据库名,默认为所有数据库。

database****
Userstring

数据库账号,默认为所有账号。

test
Formstring

审计记录返回的展示类型,取值:

  • File:触发审计日志文件的生成,若传入这个值,只返回公共参数。
  • Stream(默认值):返回数据流。
Stream
QueryKeywordsstring

关键字查询。多个关键字以空格分隔,不超过 10 个关键字。

slow
LogicalOperatorstring

关键字搜索的逻辑操作, 默认值为 and。

and
PageSizeinteger

每页记录数。取值:30(默认值)、50100

30
PageNumberinteger

页码。大于 0,且不超过 Integer 的最大值,默认值为 1

1
OrderTypestring

按时间的升降序对查询到的慢日志进行排序。取值:

  • asc:按时间升序排序。
  • desc:按时间降序排序。
asc

返回参数

名称类型描述示例值
object

总记录数。

TotalRecordCountinteger

总记录数。

40
PageRecordCountinteger

当前页最大记录数。

30
RequestIdstring

请求 ID。

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

页码。

1
Itemsobject []

审计日志详情列表。

HostAddressstring

客户端 IP 地址。

11.xxx.xxx.xxx
TableNamestring

MongoDB 的集合名称。

C1
ReturnRowCountslong

返回记录数。

2
DBNamestring

数据库名。

test123
ExecuteTimestring

该语句执行的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-03-11T03:30:27Z
ThreadIDstring

线程 ID。

140682188297984
TotalExecutionTimeslong

消耗时间,单位为微秒。

700
Syntaxstring

执行语句。

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

数据库账号名。

test

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.FormatSpecified start time is not valid.指定的开始时间无效。
400InvalidEndTime.FormatSpecified end time is not valid.EndTime(查询结束时间)参数值格式不正确,请重新配置。格式要求:yyyy-MM-ddTHH:mmZ(UTC时间)。查询结束时间必须晚于查询开始时间。
400InvalidEndTime.InvalidSpecified end time is before this service active time.-
400InvalidParameterCombinationThe end time must be greater than the start time.结束时间必须大于开始时间。
400InvalidQueryKeyword.FormatSpecified Query Keyword is not valid.-
400InvalidDatabase.FormatSpecified Database is not valid.-
400InvalidQueryTime.FormatSpecified query time is not valid.-
403IncorrectSQLLogActiveStatusCurrent DB instance SQL log active status does not support this operation.-
403LogApiFrequencyExceededExceeding the allowed frequency of log api.日志API访问量超过允许上限。
403ConcurrentTaskExceededConcurrent task exceeding the allowed amount.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:LogicalOperator
  • 本页导读 (1)
文档反馈