All Products
Search
Document Center

AnalyticDB:DescribeDBClusterPerformance

Last Updated:Aug 30, 2024

Queries the performance data of an AnalyticDB for MySQL cluster.

Operation description

You can call this operation to query the performance data of a cluster over a time range based on its performance metrics. The data is collected every 30 seconds. This operation allows you to query information about slow queries, such as the SQL query duration, number of scanned rows, and amount of scanned data.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeDBClusterPerformancelist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
am-************
KeystringYes

The performance metrics to be queried. Separate multiple values with commas (,). Valid values:

  • CPU

    • AnalyticDB_CPU: the average CPU utilization.
  • Connections

    • AnalyticDB_Connections: the number of connections of the cluster.
  • Writes

    • AnalyticDB_TPS: the write transactions per second (TPS).
    • AnalyticDB_InsertRT: the write response time.
    • AnalyticDB_InsertBytes: the write throughput.
  • Updates

    • AnalyticDB_UpdateRT: the update response time.
  • Deletes

    • AnalyticDB_DeleteRT: the delete response time.
  • Queries

    • AnalyticDB_QPS: the queries per second (QPS).
    • AnalyticDB_QueryRT: the query response time.
    • AnalyticDB_QueryWaitTime: the query wait time.
  • Disks

    • AnalyticDB_IO: the disk I/O throughput.
    • AnalyticDB_IO_UTIL: the disk I/O usage.
    • AnalyticDB_IO_WAIT: the disk I/O wait time.
    • AnalyticDB_IOPS: the disk IOPS.
    • AnalyticDB_DiskUsage: the disk space that is used.
    • AnalyticDB_HotDataDiskUsage: the disk space that is used by hot data.
    • AnalyticDB_ColdDataDiskUsage: the disk space that is used by cold data.
  • Other

    • AnalyticDB_BuildTaskCount: the number of BUILD jobs.
    • AnalyticDB_ComputeMemoryUsedRatio: the compute memory usage.
Note If you leave this parameter empty, the values of all the preceding performance metrics are returned.
AnalyticDB_CPU
StartTimestringYes

The start time of the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2021-05-03T15:00Z
EndTimestringYes

The end time of the 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 maximum time range that can be specified is two days.
2021-05-03T15:01Z
RegionIdstringYes

The region ID of the cluster.

cn-hangzhou
ResourcePoolsstringNo

The name of the resource group.

test

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

EndTimestring

The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-05-03T15:01:00Z
RequestIdstring

The request ID.

25B56BC7-4978-40B3-9E48-4B7067******
StartTimestring

The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-05-03T15:00:00Z
DBClusterIdstring

The cluster ID.

am-************
Performancesarray<object>

The queried performance metrics.

object

The queried performance metric.

Keystring

The name of the performance metric.

AnalyticDB_CPU
Unitstring

The unit of the performance metric.

%
Seriesarray<object>

The queried performance metric data.

object

The queried performance metric data.

Valuesarray

The values of the queried performance metric.

string

The value of the performance metric at a specific point in time.

[ "2021-05-03T15:00:12.72Z", "0.1250" ], [ "2021-05-03T15:00:42.739Z", "0.3125" ]
Namestring
  • CPU

    • AnalyticDB_CPU: the average CPU utilization.

      • worker_avg_cpu_used: the average CPU utilization across storage nodes.
      • worker_max_cpu_used: the maximum CPU utilization across storage nodes.
      • executor_avg_cpu_used: the average CPU utilization across compute nodes.
      • executor_max_cpu_used: the maximum CPU utilization across compute nodes.
  • Connections

    • AnalyticDB_Connections: the number of connections of the cluster.

      • connections: the number of connections of the cluster.
  • Writes

    • AnalyticDB_TPS: the write TPS.

      • tps: the sum of the insert_tps, update_tps, delete_tps, and load_tps values.
      • insert_tps: the number of successful INSERT INTO VALUES operations per second.
      • update_tps: the number of successful UPDATE operations per second.
      • delete_tps: the number of successful DELETE operations per second.
      • load_tps: the number of successful INSERT OVERWRITE operations per second.
    • AnalyticDB_InsertRT: the write response time.

      • insert_avg_rt: the average amount of time consumed by writes.
      • insert_max_rt: the maximum amount of time consumed by a single write.
    • AnalyticDB_InsertBytes: the write throughput.

      • insert_in_bytes: the amount of written data.
  • Updates

    • AnalyticDB_UpdateRT: the update response time.

      • updateinto_avg_rt: the average amount of time consumed by updates.
      • updateinto_max_rt: the maximum amount of time consumed by a single update.
  • Deletes

    • AnalyticDB_DeleteRT: the delete response time.

      • delete_avg_rt: the average amount of time consumed by deletes.
      • delete_max_rt: the maximum amount of time consumed by a single delete.
  • Queries

    • AnalyticDB_QPS: the QPS.

      • qps: the number of SELECT operations completed per second.
      • etl_qps: the number of INSERT OVERWRITE operations completed per second.
    • AnalyticDB_QueryRT: the query response time.

      • query_avg_rt: the average amount of time consumed by queries.
      • query_max_rt: the maximum amount of time consumed by a single query.
      • etl_avg_rt: the average amount of time consumed by extract-transform-load (ETL) operations.
      • etl_max_rt: the maximum amount of time consumed by a single ETL operation.
    • AnalyticDB_QueryWaitTime: the query wait time.

      • query_avg_wait_time: the average wait time for SELECT and ETL operations.
      • query_max_wait_time: the maximum wait time for SELECT and ETL operations.
    • AnalyticDB_QueryFailedRatio: the query failure rate.

      • query_failed_ratio: the failure rate of SELECT and ETL operations.
  • Disks

    • AnalyticDB_IO: the disk I/O throughput.

      • worker_avg_read_bytes_ratio: the average read throughput across storage nodes.
      • worker_avg_write_bytes_ratio: the average write throughput across storage nodes.
    • AnalyticDB_IO_UTIL: the disk I/O usage.

      • worker_avg_io_util: the disk I/O usage across storage nodes.
    • AnalyticDB_IO_WAIT: the disk I/O wait time.

      • worker_avg_io_await: the average I/O wait time of storage nodes.
    • AnalyticDB_IOPS: the disk IOPS.

      • worker_avg_read_ratio: the average read IOPS of storage nodes.
      • worker_avg_write_ratio: the average write IOPS of storage nodes.
    • AnalyticDB_DiskUsage: the disk space that is used.

      • disk_used_ratio: the average disk space usage across nodes.
      • worker_max_node_disk_used_ratio: the maximum disk space usage across nodes.
    • AnalyticDB_HotDataDiskUsage: the disk space that is used by hot data.

      • local_disk_used: the disk space that is used by hot data.
    • AnalyticDB_ColdDataDiskUsage: the disk space that is used by cold data.

      • remote_disk_used: the disk space that is used by cold data.
    • AnalyticDB_DiskUsedRatio: the node disk usage.

      • disk_used_ratio: the average disk usage across nodes.
      • worker_max_node_disk_used_ratio: the maximum disk usage across nodes.
    • AnalyticDB_DiskUsedSize: the total data size of the cluster.

      • disk_no_log_used: the total data size of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in reserved mode.
      • disk_no_log_used_max: the maximum data size of nodes of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in reserved mode.
      • disk_no_log_used_avg: the average data size of nodes of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in reserved mode.
      • user_used_disk_max: the maximum hot data size of nodes of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in elastic mode for Cluster Edition.
      • user_used_disk_avg: the average hot data size of nodes of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in elastic mode for Cluster Edition.
      • hot_disk_used: the hot data size of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in elastic mode for Cluster Edition.
      • cold_disk_used: the cold data size of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster in elastic mode for Cluster Edition.
  • Other

    • AnalyticDB_BuildTaskCount: the number of BUILD jobs.

      • max_build_task_count: the maximum number of running BUILD jobs across nodes.
      • avg_build_task_count: the average number of running BUILD jobs across nodes.
    • AnalyticDB_ComputeMemoryUsedRatio: the compute memory usage.

      • max_worker_compute_memory_used_ratio: the maximum compute memory usage across storage nodes.
      • avg_worker_compute_memory_used_ratio: the average compute memory usage across storage nodes.
      • max_executor_compute_memory_used_ratio: the maximum compute memory usage across compute nodes.
      • avg_executor_compute_memory_used_ratio: the average compute memory usage across compute nodes.
    • AnalyticDB_UnavailableNodeCount: the number of unavailable nodes.

      • worker_unavailable_node_count: the number of unavailable storage nodes.
      • executor_unavailable_node_count: the number of unavailable compute nodes.
  • WLM

    • AnalyticDB_WLM_ResubmitQueries_Count: the number of resubmitted WLM queries.

      • AnalyticDB_WLM_ResubmitQueries_Count: the number of resubmitted WLM queries.
    • AnalyticDB_WLM_SQA_AvgRt_MS: the average amount of time consumed by accelerated short WLM queries.

      • AnalyticDB_WLM_SQA_AvgRt_MS: the average amount of time consumed by accelerated short WLM queries.
    • AnalyticDB_WLM_SQA_Queries_Count: the number of accelerated short WLM queries.

      • AnalyticDB_WLM_SQA_Queries_Count: the number of accelerated short WLM queries.
    • AnalyticDB_WLM_TotalQueries_Count: the total number of WLM queries.

      • AnalyticDB_WLM_TotalQueries_Count: the total number of WLM queries.
  • AnalyticDB Pipeline Service (APS)

    • AnalyticDB_APS_BPS: the bytes per second (BPS) of APS provided by the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

      • APS_Read_BPS: the read BPS of APS.
    • AnalyticDB_APS_CPU: the CPU utilization of APS provided by the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

      • APS_CPU_Avg_Usage_Percentage: the average CPU utilization of APS.
      • APS_CPU_Max_Usage_Percentage: the maximum CPU utilization of APS.
    • AnalyticDB_APS_Memory: the memory usage of APS provided by the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

      • APS_Memory_Avg_Usage_Percentage: the average memory usage of APS.
      • APS_Memory_Max_Usage_Percentage: the maximum memory usage of APS.
    • AnalyticDB_APS_RPS: the number of records per second of APS provided by the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

      • APS_Read_RPS: the number of read records per second of APS.
    • AnalyticDB_APS_RT: the response time of APS provided by the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

      • AnalyticDB_APS_RT: the average response time of APS.
      • APS_Read_Max_RT: the maximum response time of APS.
worker_avg_cpu_used
Tagsstring

The tags that are added to the cluster.

instance_name: "amv-8vbf80pjcz*****"

Examples

Sample success responses

JSONformat

{
  "EndTime": "2021-05-03T15:01:00Z",
  "RequestId": "25B56BC7-4978-40B3-9E48-4B7067******",
  "StartTime": "2021-05-03T15:00:00Z",
  "DBClusterId": "am-************",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[               \"2021-05-03T15:00:12.72Z\",               \"0.1250\"             ],             [               \"2021-05-03T15:00:42.739Z\",               \"0.3125\"             ]"
          ],
          "Name": "worker_avg_cpu_used",
          "Tags": "instance_name: \"amv-8vbf80pjcz*****\""
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError message
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

Change history

Change timeSummary of changesOperation
2023-10-10API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-04-06The Error code has changedView Change Details