调用DescribeAuditRecords接口查询MongoDB实例的审计日志。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAuditRecords

系统规定参数。取值:DescribeAuditRecords

RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。

DBInstanceId String dds-bp12c5b040dc****

实例ID。

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

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

说明DBInstanceId参数传入的是分片集群实例ID时,本参数才可用。
StartTime String 2019-03-13T12:11:14Z

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

EndTime String 2019-03-13T13:11:14Z

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

说明 查询结束时间距查询开始时间不得超过24个小时,超过则调用失败。
Database String testdatabase

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

User String root

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

Form String Stream

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

  • File:触发审计日志文件的生成,若传入这个值,只返回公共参数,需再调用DescribeAuditFiles获取文件的下载地址。
  • Stream:返回数据流。

默认为Stream

QueryKeywords String slow

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

PageSize Integer 30

每页记录数,取值:3050100,默认值为30

PageNumber Integer 1

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

OrderType String asc

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

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

返回数据

名称 类型 示例值 描述
TotalRecordCount Integer 40

总记录数。

PageRecordCount Integer 30

当前页最大记录数。

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

请求ID。

PageNumber Integer 1

页码。

Items Array of SQLRecord

审计日志详情列表。

SQLRecord
HostAddress String 11.xxx.xxx.xxx

客户端IP地址。

TableName String C1

MongoDB的集合名称。

ReturnRowCounts Long 2

返回记录数。

DBName String test123

数据库名。

ExecuteTime String 2019-03-11T03:30:27Z

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

ThreadID String 140682188297984

线程ID。

TotalExecutionTimes Long 700

消耗时间,单位为微秒。

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

执行语句。

AccountName String root

数据库账号名。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeAuditRecords
&StartTime=2019-03-13T12:11:14Z
&EndTime=2019-03-13T13:11:14Z
&DBInstanceId=dds-bp12c5b040dc****
&<公共请求参数>

正常返回示例

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>

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
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidEndTime.Format Specified end time is not valid. EndTime(查询结束时间)参数值格式不正确,请重新配置。格式要求:yyyy-MM-ddTHH:mmZ(UTC时间)。查询结束时间必须晚于查询开始时间。

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