DescribeDBClusterPerformance - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Views the performance data of an ApsaraDB for ClickHouse Community-Compatible Edition cluster.

Operation description

You can view the performance monitoring data for a specified cluster within a time range based on performance metrics. The data is collected every 30 seconds.

Note

This operation supports only ApsaraDB for ClickHouse Community-Compatible Edition clusters that were created before December 1, 2021.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp125e3uu94wo****
Key	string	No	The performance metrics that you want to query. Separate multiple metric names with a comma (,). You can query up to five performance metrics at a time. The following performance metrics are supported: Note Key is required. CPU: CPU_USAGE: The CPU utilization. Memory: MEM_USAGE: The memory utilization. MEM_USAGE_SIZE: The memory usage in MB. Disk: DISK_USAGE: The disk utilization. DISK_USAGE_SIZE: The disk usage in MB. IOPS: The disk input/output operations per second (IOPS). Connection: CONN_USAGE: The database connection utilization. CONN_USAGE_COUNT: The number of database connections. Write: TPS: The number of rows written per second (TPS). INSERT_SIZE: The write size per second in MB. Query: QPS: The queries per second (QPS). AVG_SEEK: The number of random SEEK calls. WAIT: ZK_WAIT: The average wait time of ZooKeeper (ZK) in ms. IO_WAIT: The average I/O wait time in ms. CPU_WAIT: The average CPU wait time in ms.	MEM_USAGE
StartTime	string	Yes	The beginning of the time range to query. Specify the time in UTC using the `yyyy-MM-ddTHH:mmZ` format.	2021-11-27T16:37Z
EndTime	string	Yes	The end of the time range to query. Specify the time in UTC using the `yyyy-MM-ddTHH:mmZ` format. Note The end time must be later than the start time. The maximum time range cannot exceed 32 days.	2021-11-27T16:38Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range that was queried. The time is in UTC, formatted as `yyyy-MM-ddTHH:mmZ`.	2021-11-27T16:38Z
RequestId	string	The request ID.	FE242962-6DA3-5FC8-9691-37B62A3210F7
StartTime	string	The beginning of the time range that was queried. The time is in UTC, formatted as `yyyy-MM-ddTHH:mmZ`.	2021-11-27T16:37Z
DBClusterId	string	The cluster ID.	cc-bp125e3uu94wo****
Performances	array<object>	The list of performance metrics for the cluster.
	array<object>	The performance metric.
Key	string	The name of the performance metric.	MEM_USAGE
Unit	string	The unit of the metric.	%
Series	array<object>	The time series data for the metric.
	array<object>	The metric information.
Values	array<object>	The values of the performance metrics, each associated with a sampling timestamp.
	object	The metric value.
Point	array	The value of the performance metric.
	string	Detailed time-series data for the performance metric.	[ "2021-11-26T16:39:00Z","15.08" ]
Name	string	The name of the time series.	cc-bp125e3uu94wo1s0k16****
Name	string	The name of the performance metric.	mem_usage

Examples

Success response

JSON format

{
  "EndTime": "2021-11-27T16:38Z",
  "RequestId": "FE242962-6DA3-5FC8-9691-37B62A3210F7",
  "StartTime": "2021-11-27T16:37Z",
  "DBClusterId": "cc-bp125e3uu94wo****",
  "Performances": [
    {
      "Key": "MEM_USAGE",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[ \"2021-11-26T16:39:00Z\",\"15.08\" ]"
              ]
            }
          ],
          "Name": "cc-bp125e3uu94wo1s0k16****"
        }
      ],
      "Name": "mem_usage"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.