调用DescribeRunningLogRecords查询实例的运行日志_云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

查询MongoDB实例的运行日志。

接口说明

本接口适用于规格类型为通用型本地盘版和独享型本地盘版实例。
本接口限制每分钟调用 30 次，如超过这个限制会被限流，请勿高频调用。如需高频调用，请使用 Logstore，详情请参见管理 Logstore。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeRunningLogRecords	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明当本参数传入的是分片集群实例 ID 时，还需要传入 NodeId 参数。	dds-bpxxxxxxxx
NodeId	string	否	分片集群实例中 Mongos 节点 ID 或 Shard 节点 ID。说明当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数才可用。	d-bpxxxxxxxx
StartTime	string	是	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2019-01-01T12:10Z
EndTime	string	是	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。说明查询结束时间距查询开始时间不得超过 24 个小时，超过则调用失败。	2019-01-01T13:10Z
DBName	string	否	数据库名。	mongodbtest
RoleType	string	否	实例中节点的角色。取值： primary：主节点。 secondary：从节点。说明当 NodeId 参数传入的是 Mongos 节点 ID 时，RoleType 取值只能为 primary。	primary
PageSize	integer	否	每页记录数，取值范围为 30~100。	30
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
OrderType	string	否	按时间的升降序对查询到的运行日志进行排序。取值： asc：按时间升序排序。 desc：按时间降序排序。	asc
ResourceGroupId	string	否	资源组 ID。	sg-bpxxxxxxxxxxxxxxxxxx
RoleId	string	否	节点的角色 ID。您可以通过 DescribeReplicaSetRole 进行查询。	651xxxxx
QueryKeywords	string	否	查询关键字，多个关键字以空格分隔，不超过 10 个关键字。	test test2
LogicalOperator	string	否	关键字搜索的逻辑操作，默认值为 and。	and

返回参数

名称	类型	描述	示例值
	object
TotalRecordCount	integer	总记录数。	2
PageRecordCount	integer	每页的记录数。	30
RequestId	string	请求 ID。	45D2B592-DEBA-4347-BBF3-47FF6C97DBBC
PageNumber	integer	页码。	1
Items	array<object>	运行日志明细列表。
	object
ConnInfo	string	日志连接信息。	conn18xxxxxx
CreateTime	string	日志生成时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-02-26T12:09:34Z
Category	string	日志类别。	NETWORK
Content	string	日志信息。	end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\n
Engine	string	当前数据库的引擎类型。	MongoDB

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 2,
  "PageRecordCount": 30,
  "RequestId": "45D2B592-DEBA-4347-BBF3-47FF6C97DBBC",
  "PageNumber": 1,
  "Items": {
    "LogRecords": [
      {
        "ConnInfo": "conn18xxxxxx",
        "CreateTime": "2019-02-26T12:09:34Z",
        "Category": "NETWORK",
        "Content": " end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\n"
      }
    ]
  },
  "Engine": "MongoDB"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameterCombination	The end time must be greater than the start time	开始时间不能大于结束时间。
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.	-
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.	-
403	LogApiFrequencyExceeded	Exceeding the allowed frequency of log api.	日志API访问量超过允许上限。

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

变更历史

变更时间	变更内容概要	操作
2024-01-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情