DescribeDBClusterPerformance - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries performance data about an ApsaraDB for ClickHouse cluster.

Operation description

You can query the performance data of a specified cluster over a specific time range based on the performance metrics. The data is collected every 30 seconds.

Note You can call this operation only for ApsaraDB for ClickHouse clusters that were created before December 1, 2021.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:DescribeDBClusterPerformance	get	All Resources *	none	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 performance metrics with commas (,). You can query up to five performance metrics at a time. You can query the following performance metrics: Note The Key parameter is required. CPU: CPU_USAGE: the CPU utilization Memory: MEM_USAGE: the memory usage MEM_USAGE_SIZE: the used memory. Unit: MB Disk: DISK_USAGE: the disk usage DISK_USAGE_SIZE: the size of the used disks. Unit: MB IOPS: the disk Input/Output Operations per Second (IOPS) Connection: CONN_USAGE: the database connection usage CONN_USAGE_COUNT: the number of database connections used Write: TPS: the number of rows written per second INSERT_SIZE: the amount of data written per second. Unit: MB Query: QPS: the queries per second AVG_SEEK: the average number of random seek calls WAIT: ZK_WAIT: the average ZooKeeper wait time. Unit: ms IO_WAIT: the average I/O wait time. Unit: ms CPU_WAIT: the average CPU wait time. Unit: ms	MEM_USAGE
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 Coordinated Universal Time (UTC).	2021-11-27T16:37Z
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 interval cannot be more than 32 days.	2021-11-27T16:38Z

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in Coordinated Universal Time (UTC).	2021-11-27T16:38Z
RequestId	string	The request ID.	FE242962-6DA3-5FC8-9691-37B62A3210F7
StartTime	string	The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2021-11-27T16:37Z
DBClusterId	string	The cluster ID.	cc-bp125e3uu94wo****
Performances	array<object>	The values of the queried performance metrics of the cluster.
PerformanceItem	object
Key	string	The name of the performance metric.	MEM_USAGE
Unit	string	The unit of the performance metric.	%
Series	array<object>	The queried performance pamaters.
SeriesItem	object
Values	array<object>	The values of the performance parameter. Each value of the performance parameter is collected at a point in time.
ValueItem	object
Point	array	The values of a metric.
Point	string	The values of the performance metrics at different points in time.	[ "2021-11-26T16:39:00Z","15.08" ]
Name	string	The name of the list of performance metric values.	cc-bp125e3uu94wo1s0k16****
Name	string	The name of the performance metric value.	mem_usage

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-26	API Description Update	View Change Details