All Products
Search
Document Center

AnalyticDB:DescribeDBClusterPerformance

最終更新日:Aug 30, 2024

Queries the performance data of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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 Data Lakehouse Edition cluster.

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

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

  • CPU

    • AnalyticDB_CPU_Usage_Percentage: the average CPU utilization.
  • Connections

    • AnalyticDB_Instance_Connection_Count: the number of database connections.
  • Writes

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

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

    • AnalyticDB_Disk_IO_Avg_Usage_Percentage: the average I/O utilization.
    • AnalyticDB_Disk_IO_Avg_Waiting_Time: the average I/O wait time.
    • AnalyticDB_IO_Throughput: the disk throughput.
    • AnalyticDB_IOPS: the disk IOPS.
    • AnalyticDB_Disk_Usage: the disk space that is used.
    • AnalyticDB_Disk_Usage_Percentage: the disk usage.
    • AnalyticDB_Hot_Data_Usage: the disk space that is used by hot data.
    • AnalyticDB_Cold_Data_Usage: the disk space that is used by code data.
Note This parameter must be specified.
AnalyticDB_CPU_Usage_Percentage
StartTimestringYes

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 UTC.

2022-03-10T23:56Z
EndTimestringYes

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 maximum time range that can be specified is two days.
2022-03-11T15:01Z
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
ResourcePoolsstringNo

The resource group ID.

user_default

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

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

2022-03-11T15:01Z
RequestIdstring

The request ID.

BD8C3096-8BC6-51DF-A4AB-BACD9DC10435
StartTimestring

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

2022-03-10T23:56Z
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
amv-bp1hx5n1o8f61****
Performancesarray<object>

The queried performance metrics.

object

The queried performance metric.

Keystring

The name of the performance metric.

AnalyticDB_CPU_Usage_Percentage
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 performance metric at different points in time.

string

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

[ [ "2023-06-27T13:21:00+08:00","0.1250" ], [ "2022-03-11T10:00:42.739Z","0.3125" ]... ]
Namestring
  • CPU

    • AnalyticDB_CPU_Usage_Percentage: the CPU utilization.

      • AnalyticDB_Storage_CPU_Avg_Usage_Percentage: the average CPU utilization across storage nodes.
      • AnalyticDB_Storage_CPU_Max_Usage_Percentage: the maximum CPU utilization across storage nodes.
      • AnalyticDB_Compute_CPU_Max_Usage_Percentage: the average CPU utilization across compute nodes.
      • AnalyticDB_Compute_CPU_Max_Usage_Percentage: the maximum CPU utilization across compute nodes.
      • AnalyticDB_CS_CPU_Avg_Usage_Percentage: the average CPU utilization across access nodes.
      • AnalyticDB_CS_CPU_Max_Usage_Percentage: the maximum CPU utilization across access nodes.
  • Connections

    • AnalyticDB_Instance_Connection_Count: the number of connections to the cluster.

      • AnalyticDB_Instance_Connection_Count: the number of connections to 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.

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

      • AnalyticDB_InsertBytes: 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.

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

      • AnalyticDB_Avg_QueryRT: the average amount of time consumed by queries.
      • AnalyticDB_Max_QueryRT: 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.

      • AnalyticDB_Avg_QueryWaitTime: the average wait time for SELECT and ETL operations.
      • AnalyticDB_Max_QueryWaitTime: 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_Throughput: the disk I/O throughput.

      • AnalyticDB_Storage_Read_IO_Throughput: the average read throughput across storage nodes.
      • AnalyticDB_Storage_Write_IO_Throughput: the average write throughput across storage nodes.
      • AnalyticDB_Compute_Read_IO_Throughput: the average read throughput across compute nodes.
      • AnalyticDB_Compute_Write_IO_Throughput: the average write throughput across compute nodes.
    • AnalyticDB_Disk_IO_Avg_Usage_Percentage: the average I/O usage.

      • AnalyticDB_Disk_IO_Avg_Usage_Percentage: the average I/O usage across storage nodes.
    • AnalyticDB_Disk_IO_Avg_Waiting_Time: the average I/O wait time.

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

      • AnalyticDB_Storage_Read_IOPS: the average read IOPS of storage nodes.
      • AnalyticDB_Storage_Write_IOPS: the average write IOPS of storage nodes.
      • AnalyticDB_Compute_Read_IOPS: the average read IOPS of compute nodes.
      • AnalyticDB_Compute_Write_IOPS: the average write IOPS of compute nodes.
    • AnalyticDB_DiskUsage: the disk storage that is used.

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

      • AnalyticDB_Hot_Data_Usage: the disk storage that is used by hot data.
    • AnalyticDB_Cold_Data_Usage: the disk storage that is used by cold data.

      • AnalyticDB_Cold_Data_Usage: the disk storage 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.

      • user_used_disk_max: the maximum hot data size across nodes.
      • user_used_disk_avg: the average hot data size across nodes.
      • hot_disk_used: the hot data size.
      • cold_disk_used: the cold data size.
  • 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 Lakehouse Edition cluster.

      • APS_Read_BPS: the read BPS of APS.
    • AnalyticDB_APS_CPU: the CPU utilization of APS provided by the AnalyticDB for MySQL Data Lakehouse Edition 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 Lakehouse Edition 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 Lakehouse Edition 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 Lakehouse Edition cluster.

      • APS_Read_Avg_RT: the average response time of APS.
      • APS_Read_Max_RT: the maximum response time of APS.
AnalyticDB_Storage_CPU_Avg_Usage_Percentage
Tagsstring

The tags that are added to the cluster.

{instance_name: "am-***"}

Examples

Sample success responses

JSONformat

{
  "EndTime": "2022-03-11T15:01Z",
  "RequestId": "BD8C3096-8BC6-51DF-A4AB-BACD9DC10435",
  "StartTime": "2022-03-10T23:56Z",
  "DBClusterId": "amv-bp1hx5n1o8f61****",
  "Performances": [
    {
      "Key": "AnalyticDB_CPU_Usage_Percentage",
      "Unit": "%",
      "Series": [
        {
          "Values": [
            "[\n  [ \n  \"2023-06-27T13:21:00+08:00\",\"0.1250\" \n  ], \n  [ \n  \"2022-03-11T10:00:42.739Z\",\"0.3125\" \n  ]...\n]"
          ],
          "Name": "AnalyticDB_Storage_CPU_Avg_Usage_Percentage",
          "Tags": "\n{instance_name: \"am-***\"}"
        }
      ]
    }
  ]
}

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-09-13The Error code has changedView Change Details