You can call this operation to query the running logs of the MongoDB instance.

This operation is applicable to replica set instances and sharded cluster instances. DescribeRunningLogRecords cannot be performed on standalone instances.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRunningLogRecords

The operation that you want to perform. Set the value to DescribeRunningLogRecords.

StartTime String Yes 2019-01-01T12:10Z

The beginning of the time range to query. The time is in the yyyy-MM-dd T HH:mm Z format.

End time String Yes 2019-01-02T12:10Z

The end of the time range that you want to query. The time is in the yyyy-MM-dd T HH:mm Z format.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Note If you specify this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
NodeId String No d-bpxxxxxxxx

The ID of the mongos or shard in the specified sharded cluster instance.

Note This parameter is only valid when you specify the DBInstanceId parameter to the ID of a sharded cluster instance.
DBName String No mongodbtest

The name of the database.

RoleType String No primary

The role of the node in the instance. Default value: LooseDispersion. Valid values:

  • primary
  • secondary
Note If you set NodeId to the ID of a Mongos, the value of RoleType must be primary.
PageSize Integer No 30

The number of records to display on each page. Valid values: 30 to 100.

PageNumber Integer No 1

The number of the page. Valid values: any non-zero positive Integer. Default value:1.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

Response parameters

Prameter Type Sample response Description
Items Array

A list of running log details.

Category String NETWORK

The category of the log.

ConnInfo String conn18xxxxxx

The log connection information.

Content String end connection (0 connections now open)\n

The contents of a log information.

CreateTime String 2019-02-26T12:09:34Z

The time when the log is generated. The time is in the yyyy-MM-dd T HH:mm:ssZ format.

PageNumber Integer 1

The page number of the page.

PageRecordCount Integer 300

The number of records per page.

RequestId String 45D2B592-DEBA-4347-BBF3-47FF6C97DBBC

The ID of the request.

TotalRecordCount Integer 2

The total number of records.


Sample requests

http(s):// Action=DescribeRunningLogRecords
&<Common request parameter>

Sample success response

XML format

                end connection (0 connections now open)
                  <Content>connection accepted from #1862051 (11 connections now open)</Content>

JSON format

    "Items": {
        "LogRecords": [
                "Category": "-",
                "CreateTime": "2019-02-26T12:09:34Z",
                "ConnInfo": "conn18xxxxxx",
                "Content": "end connection (0 connections now open)\n"
                "Category": "NETWORK",
                "CreateTime": "2019-02-26T12:09:34Z",
                "ConnInfo": "thread1",
                "Content": "connection accepted from #1862051 (11 connections now open)"
    "PageNumber": 1,
    "TotalRecordCount": 2,
    "RequestId": "45D2B592-DEBA-4347-BBF3-47FF6C97DBBC"

Error codes.

For a list of error codes, visit the API Error Center.