DescribeSlowLogRecords - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the details of slow query logs.

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

clickhouse:DescribeSlowLogRecords

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Call the DescribeRegions operation to query the region ID.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. Call the DescribeDBClusters operation to query information about all clusters in the destination region, including cluster IDs.	cc-bp1z58t881wcx****
StartTime	string	Yes	The beginning of the time range to query. The format is `yyyy-MM-dd hh:mm:ss`. The time is in UTC.	2022-05-20 16:00:00
EndTime	string	Yes	The end of the time range to query. The format is `yyyy-MM-dd hh:mm:ss`. The time is in UTC. Note The end time must be later than the start time. The interval between the start time and the end time cannot exceed 7 days.	2022-05-27 16:00:00
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	No	The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.	1
QueryDurationMs	integer	No	The minimum query duration, in milliseconds. The minimum value is 1000. The default value is 1000. The response returns information about queries that take longer than the specified duration.	1000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	DF203CC8-5F68-5E3F-8050-3C77DD65731A
SlowLogRecords	object	The details of the slow query logs.
TableSchema	object
ResultSet	array<object>	The structure of the database table.
	object
Type	string	The column type.	String
Name	string	The column name.	name
Data	object
ResultSet	array<object>	The list of slow query log entries.
	object
Type	string	The query status. Valid values: QueryFinish: The query is complete. Processing: The query is running.	QueryFinish
QueryStartTime	string	The start time of the query. The format is `yyyy-MM-dd hh:mm:ss`. The time is in UTC.	2022-05-22 20:00:01
Query	string	The query statement.	Select * from table
ReadRows	string	The number of rows read for the query.	10027008
InitialAddress	string	The IP address of the client that initiated the query.	::ffff:100.104.XX.XX
MemoryUsage	string	The peak memory usage for the query, in bytes.	1048576
InitialUser	string	The username that was used to initiate the query.	test_users
InitialQueryId	string	The query ID.	'b51496f2-6b0b-4546-aff9-e17951cb9410'
ReadBytes	string	The amount of data read for the query, in bytes.	1048576
QueryDurationMs	string	The time consumed by the query, in milliseconds.	2000
ResultBytes	string	The size of the result data, in bytes.	1024
Rows	string	The number of rows in the result set.	1
RowsBeforeLimitAtLeast	string	The number of entries on each page.	1
Statistics	object	The statistics of the query results.
RowsRead	integer	The number of rows read.	2016722
ElapsedTime	number	The time elapsed for the slow query, in milliseconds.	21.35
BytesRead	integer	The amount of data read, in bytes.	123456

Examples

Success response

JSON format

{
  "RequestId": "DF203CC8-5F68-5E3F-8050-3C77DD65731A",
  "SlowLogRecords": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "String",
          "Name": "name"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "Type": "QueryFinish",
          "QueryStartTime": "2022-05-22 20:00:01",
          "Query": "Select * from table",
          "ReadRows": "10027008",
          "InitialAddress": "::ffff:100.104.XX.XX",
          "MemoryUsage": "1048576",
          "InitialUser": "test_users",
          "InitialQueryId": "'b51496f2-6b0b-4546-aff9-e17951cb9410'",
          "ReadBytes": "1048576",
          "QueryDurationMs": "2000",
          "ResultBytes": "1024"
        }
      ]
    },
    "Rows": "1",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 2016722,
      "ElapsedTime": 21.35,
      "BytesRead": 123456
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.