DescribeSlowLogTrend - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries statistics about the slow log trends for a cluster.

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:DescribeSlowLogTrend

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 region IDs.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. Call the DescribeDBClusters operation to query information about all clusters in a specific region, including cluster IDs.	cc-bp11xxl475ui8****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the `yyyy-MM-dd hh:mm:ss` format. The time is in UTC.	2022-05-20 16:00:00
EndTime	string	Yes	The end of the time range to query. Specify the time in the `yyyy-MM-dd hh:mm:ss` format. The time is in UTC. Note The end time must be later than the start time. The time range cannot exceed 7 days.	2022-05-27 16:00:00
QueryDurationMs	integer	No	The execution duration of a slow SQL query, in milliseconds. The minimum value is 1000. The default value is 1000. The operation returns slow SQL queries that take longer than this duration to execute.	1000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF
SlowLogTrend	object	The result set of the slow SQL queries.
TableSchema	object
ResultSet	array<object>	The table schema.
	object	The schema of the result table.
Type	string	The column type.	UInt64
Name	string	The column name.	query_start_time
Data	object
ResultSet	array<object>	The list of slow SQL queries.
	object	The list of slow SQL queries.
QueryStartTime	string	The start time of the query. The time is in the `yyyy-MM-dd hh:mm:ss` format. The time is in UTC.	2022-05-22 20:00:01
MaxQueryDurationMs	string	The longest execution duration. Unit: milliseconds.	3000
MinQueryDurationMs	string	The shortest execution duration. Unit: milliseconds.	1000
Count	string	The total execution duration of slow SQL queries. Unit: milliseconds.	4000
AvgQueryDurationMs	string	The average execution duration. Unit: milliseconds.	2000
Rows	string	The number of rows in the result set.	1
RowsBeforeLimitAtLeast	string	The minimum number of rows that are returned before the `LIMIT` clause is applied.	1
Statistics	object	The statistics of the query results.
RowsRead	integer	The number of rows read.	14721
ElapsedTime	number	The query execution duration. Unit: seconds.	0.001703578
BytesRead	integer	The amount of data read. Unit: bytes.	697899

Examples

Success response

JSON format

{
  "RequestId": "7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF",
  "SlowLogTrend": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "UInt64",
          "Name": "query_start_time"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "QueryStartTime": "2022-05-22 20:00:01",
          "MaxQueryDurationMs": "3000",
          "MinQueryDurationMs": "1000",
          "Count": "4000",
          "AvgQueryDurationMs": "2000"
        }
      ]
    },
    "Rows": "1",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 14721,
      "ElapsedTime": 0.001703578,
      "BytesRead": 697899
    }
  }
}

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.