DescribeSlowLogRecords - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the details of entries in slow query logs of an ApsaraDB for MongoDB instance.

Operation description

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeSlowLogRecords

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter.	dds-bp1fc7e65108****
NodeId	string	No	The ID of the shard node. Note This parameter is required only when you specify the `DBInstanceId` parameter to the ID of a sharded cluster instance.	d-bp18b06ebc21****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2021-08-15T14:13Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note The end time must be later than the start time. The end time must be within 24 hours from the start time. Otherwise, the query fails.	2021-08-16T14:13Z
DBName	string	No	The name of the database.	mongodbtest
QueryKeywords	string	No	The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.	test test1
LogicalOperator	string	No	The logical relationship among multiple keywords. or and (default value)	and
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 to 100.	30
PageNumber	integer	No	The page number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1
OrderType	string	No	The order of time in which the 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.	asc
ResourceGroupId	string	No	The ID of the resource group to which the instances you want to query belong.	rg-acfmyiu4ekp****

Response elements

Element	Type	Description	Example
	object
TotalRecordCount	integer	The total number of returned entries.	1
PageRecordCount	integer	The number of slow query log entries returned on the page.	1
RequestId	string	The request ID.	8076C4BA-DDBD-529C-BFF4-D8620C3F****
PageNumber	integer	The page number of the returned page. The value is a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1
Items	object
LogRecords	array<object>	An array that consists of the information about each slow query.
	object
ExecutionStartTime	string	The start time of the operation. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-25T 01:41:28Z
HostAddress	string	The host IP address that is used to connect to the database.	192.168.XX.XX
QueryTimes	string	The execution time of the statement. Unit: milliseconds.	600
TableName	string	The name of the collection.	C1
SQLText	string	The SQL statement that is executed during the slow operation.	{\"op\":\"query\",\"ns\":\"mongodbtest.customer\",\"query\":{\"find\":\"customer\",\"filter\":{\"name\":\"jack\"}}}
ReturnRowCounts	integer	The number of rows returned by the SQL statement.	0
KeysExamined	integer	The number of rows involved in index scans.	0
DBName	string	The name of the database.	mongodbtest
DocsExamined	integer	The number of documents that are scanned during the operation.	1000000
AccountName	string	The username of the database account that performs the operation.	test
Engine	string	The database engine.	MongoDB

Examples

Success response

JSON format

{
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "8076C4BA-DDBD-529C-BFF4-D8620C3F****",
  "PageNumber": 1,
  "Items": {
    "LogRecords": [
      {
        "ExecutionStartTime": "2019-02-25T 01:41:28Z",
        "HostAddress": "192.168.XX.XX",
        "QueryTimes": "600",
        "TableName": "C1",
        "SQLText": "{\\\"op\\\":\\\"query\\\",\\\"ns\\\":\\\"mongodbtest.customer\\\",\\\"query\\\":{\\\"find\\\":\\\"customer\\\",\\\"filter\\\":{\\\"name\\\":\\\"jack\\\"}}}",
        "ReturnRowCounts": 0,
        "KeysExamined": 0,
        "DBName": "mongodbtest",
        "DocsExamined": 1000000,
        "AccountName": "test"
      }
    ]
  },
  "Engine": "MongoDB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
400	InvalidParameterCombination	The end time must be greater than the start time	The start time must be earlier than the end 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.