调用DescribeSlowLogRecords接口查询MongoDB实例运行出现的慢日志明细。
- 本接口仅适用于副本集实例和分片集群实例。
- 本接口限制每分钟调用30次,如超过这个限制会被限流,请勿高频调用。如需高频调用,请使用Logstore,详情请参见管理Logstore。
- 如果是2021年06月06日后新购买的实例,您需要先开通审计日志功能,并设置需要审计的操作类型(包含admin和slow),然后查看此后出现的慢日志。
说明
- 您可以通过调用接口ModifyAuditPolicy开启或关闭审计日志。
- 您可以通过调用接口ModifyAuditLogFilter设置需要审计的操作类型。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSlowLogRecords | 系统规定参数。取值:DescribeSlowLogRecords。 |
RegionId | String | 否 | cn-hangzhou | 实例所属的地域ID。
说明 您可以通过调用接口
DescribeDBInstanceAttribute查询。
|
DBInstanceId | String | 是 | dds-bp1fc7e65108**** | 实例ID。
说明 如果是分片集群实例,您还需要配置
NodeId 。
|
NodeId | String | 否 | d-bp18b06ebc21**** | Shard节点ID。
说明 如果
DBInstanceId 配置的是分片集群实例的ID,需要配置该参数。
|
StartTime | String | 是 | 2021-08-15T14:13Z | 查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。 |
EndTime | String | 是 | 2021-08-16T14:13Z | 查询结束时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。
说明
|
DBName | String | 否 | mongodbtest | 数据库名。 |
PageSize | Integer | 否 | 30 | 每页记录数,取值范围为30~100。 |
PageNumber | Integer | 否 | 1 | 页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
OrderType | String | 否 | asc | 按时间的升降序对查询到的慢日志进行排序。取值如下:
|
ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** | 资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalRecordCount | Integer | 1 | 总记录数。 |
PageRecordCount | Integer | 1 | 本页慢操作日志明细的个数。 |
RequestId | String | 8076C4BA-DDBD-529C-BFF4-D8620C3F**** | 请求ID。 |
PageNumber | Integer | 1 | 页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
Items | Array of LogRecords | 慢日志明细列表。 |
|
LogRecords | |||
ExecutionStartTime | String | 2019-02-25T 01:41:28Z | 操作执行的开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
HostAddress | String | 192.168.XX.XX | 连接数据库的主机地址。 |
QueryTimes | String | 600 | 该语句的执行时长,单位为毫秒。 |
TableName | String | C1 | MongoDB的集合名称。 |
SQLText | String | {\"op\":\"query\",\"ns\":\"mongodbtest.customer\",\"query\":{\"find\":\"customer\",\"filter\":{\"name\":\"jack\"}}} | 慢操作执行的语句。 |
ReturnRowCounts | Long | 0 | 返回行数。 |
KeysExamined | Long | 0 | 索引扫描行数。 |
DBName | String | mongodbtest | 数据库名。 |
DocsExamined | Long | 1000000 | 该操作执行时扫描的文档数。 |
AccountName | String | root | 执行该操作的数据库用户名。 |
Engine | String | MongoDB | 当前数据库的引擎类型。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeSlowLogRecords &DBInstanceId=dds-bp1366caac83**** &StartTime=2021-08-15T14:13Z &EndTime=2021-08-16T14:13Z &公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK Content-Type:application/xml <DescribeSlowLogRecordsResponse> <TotalRecordCount>1</TotalRecordCount> <PageRecordCount>1</PageRecordCount> <RequestId>8076C4BA-DDBD-529C-BFF4-D8620C3F****</RequestId> <PageNumber>1</PageNumber> <Items> <LogRecords> <TableName>$cmd</TableName> <QueryTimes>944</QueryTimes> <ExecutionStartTime>2021-08-15T21:08:36Z</ExecutionStartTime> <DBName>admin</DBName> <HostAddress>11.61.195.204</HostAddress> <SQLText>{"op":"command","ns":"admin.$cmd","command":{"isMaster":1,"client":{"driver":{"name":"mgo","version":"vinllen"},"os":{"type":"linux","architecture":"amd64"}},"$readPreference":{"mode":"secondaryPreferred"},"$db":"admin"},"numYield":0,"locks":{},"flowControl":{},"responseLength":748,"protocol":"op_query","millis":944,"replRole":{"stateStr":"SECONDARY","_id":1}}</SQLText> </LogRecords> </Items> <Engine>MongoDB</Engine> </DescribeSlowLogRecordsResponse>
JSON
格式
HTTP/1.1 200 OK Content-Type:application/json { "TotalRecordCount" : 1, "PageRecordCount" : 1, "RequestId" : "8076C4BA-DDBD-529C-BFF4-D8620C3F****", "PageNumber" : 1, "Items" : { "LogRecords" : [ { "TableName" : "$cmd", "QueryTimes" : 944, "ExecutionStartTime" : "2021-08-15T21:08:36Z", "DBName" : "admin", "HostAddress" : "11.61.195.204", "SQLText" : "{\"op\":\"command\",\"ns\":\"admin.$cmd\",\"command\":{\"isMaster\":1,\"client\":{\"driver\":{\"name\":\"mgo\",\"version\":\"vinllen\"},\"os\":{\"type\":\"linux\",\"architecture\":\"amd64\"}},\"$readPreference\":{\"mode\":\"secondaryPreferred\"},\"$db\":\"admin\"},\"numYield\":0,\"locks\":{},\"flowControl\":{},\"responseLength\":748,\"protocol\":\"op_query\",\"millis\":944,\"replRole\":{\"stateStr\":\"SECONDARY\",\"_id\":1}}" } ] }, "Engine" : "MongoDB" }
错误码
访问错误中心查看更多错误码。