DescribeRunningLogRecords -

This operation is applicable only to general-purpose local-disk and dedicated local-disk instances.
You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see Manage a Logstore.

Debugging

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.
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.
DBInstanceId	String	Yes	dds-bpxxxxxxxx	The ID of the instance. Note If you set 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 node or shard node whose operational logs you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter. Note This parameter is valid only when DBInstanceId is set to the ID of a sharded cluster instance.
StartTime	String	Yes	2019-01-01T12:10Z	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.
EndTime	String	Yes	2019-01-01T13:10Z	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note The end time must be later than the start time and within 24 hours from the start time. Otherwise, the query fails.
DBName	String	No	mongodbtest	The name of the database.
RoleType	String	No	primary	The role of the node whose error logs you want to query in the instance. Valid values: primary secondary Note If you set the NodeId parameter to the ID of a mongos node, the RoleType parameter must be set to primary.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30 to 100.
PageNumber	Integer	No	1	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.
OrderType	String	No	asc	The order of time in which the operational log entries to return are sorted. Valid values: asc: The log entries are sorted by time in ascending order. desc: The log entries are sorted by time in descending order.
ResourceGroupId	String	No	sg-bpxxxxxxxxxxxxxxxxxx	The ID of the resource group.
RoleId	String	No	651xxxxx	The role ID of the node. You can call the DescribeReplicaSetRole operation to query the role ID.

Response parameters


Parameter	Type	Example	Description
TotalRecordCount	Integer	2	The total number of entries.
PageRecordCount	Integer	30	The number of entries returned per page.
RequestId	String	45D2B592-DEBA-4347-BBF3-47FF6C97DBBC	The ID of the request.
PageNumber	Integer	1	The number of the page to return.
Items	Array of LogRecords		Details about the operational log entries.
LogRecords
ConnInfo	String	conn18xxxxxx	The connection information of the log entry.
CreateTime	String	2019-02-26T12:09:34Z	The time when the log entry was generated. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Category	String	NETWORK	The category of the log entry. Valid values:
Content	String	end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\n	The content of the log entry.
Id	Integer	1111111111	The ID of the log entry.
Engine	String	MongoDB	The database engine.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeRunningLogRecords
&StartTime=2019-01-01T12:10Z
&EndTime=2019-01-01T13:10Z
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeRunningLogRecordsResponse>
	<Items>
		<LogRecords>
			<Category>-</Category>
			<CreateTime>2019-02-26T12:09:34Z</CreateTime>
			<ConnInfo>conn18xxxxxx</ConnInfo>
			<Content>
				end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)
			</Content>
		</LogRecords>
		<LogRecords>
			<Category>NETWORK</Category>
			<CreateTime>2019-02-26T12:09:34Z</CreateTime>
			<ConnInfo>thread1</ConnInfo>
			<Content>connection accepted from 11.xxx.xxx.xx:3xxxx #1862051 (11 connections now open)</Content>
		</LogRecords>
	</Items>
	<PageNumber>1</PageNumber>
	<TotalRecordCount>2</TotalRecordCount>
	<RequestId>45D2B592-DEBA-4347-BBF3-47FF6C97DBBC</RequestId>
</DescribeRunningLogRecordsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Items" : {
    "LogRecords" : [ {
      "Category" : "-",
      "CreateTime" : "2019-02-26T12:09:34Z",
      "ConnInfo" : "conn18xxxxxx",
      "Content" : "end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\n"
    }, {
      "Category" : "NETWORK",
      "CreateTime" : "2019-02-26T12:09:34Z",
      "ConnInfo" : "thread1",
      "Content" : "connection accepted from 11.xxx.xxx.xx:3xxxx #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.