All Products
Search
Document Center

DescribeDBClusterPerformance

Last Updated: Jun 03, 2020

Queries the performance data of an AnalyticDB for MySQL cluster.

You can determine the performance of a cluster over a specific time range based on its performance metrics. The performance data is monitored every 30 seconds.Support for querying slow query, providing monitoring content such as SQL query duration, number of scan lines, scan volume, etc.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterPerformance The operation that you want to perform. Set the value to

DescribeDBClusterPerformance.

DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose performance data is to be queried.
Key String No AnalyticDB_CPU The performance metrics to be queried. Separate multiple metrics with commas (,). If this parameter is not specified, all the following metrics are returned:
  • CPU

    AnalyticDB_CPU: the average CPU usage.

  • Number of connections

    AnalyticDB_Connections: the number of database connections.

  • Write
    • AnalyticDB_TPS: the number of write transactions per second (TPS).
    • AnalyticDB_InsertRT: the write response time.
    • AnalyticDB_InsertBytes: the write throughput.
  • Query
    • AnalyticDB_QPS: the number of queries per second (QPS).
    • AnalyticDB_QueryRT: the response time of queries.
    • AnalyticDB_QueryWaitTime: the total wait time of queries.
  • Disks
    • AnalyticDB_IO: the I/O throughput of the disk.
    • AnalyticDB_IOPS: the number of disk input/output operations per second (IOPS).
    • AnalyticDB_DiskUsage: the disk usage.
StartTime String Yes 2012-06-08T15:00Z The beginning of the time range to query. Format: yyyy-MM-ddTHH:mmZ
EndTime String Yes 2012-06-18T15:00Z The end of the time range to query. Format: yyyy-MM-ddTHH:mmZ

Response parameters

Parameter Type Example Description
DBClusterId String rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose performance data is found.
StartTime String 2012-06-08T15:00Z The beginning of the time range specified for the query. Format: yyyy-MM-ddTHH:mmZ
EndTime String 2012-06-18T15:00Z The end of the time range specified for the query. Format: yyyy-MM-ddTHH:mmZ
Performances The information about performance metrics of the cluster.
└Key String AnalyticDB_CPU The key of a performance metric.
└Unit String KB The unit of the performance metric.
└Series - - The data of the performance metric.
└Name String insert_avg_rt The name of the performance metric.
└Values List<String[]> [ [ "2019-05-06T05:17:46.487Z", 5 ], [ "2019-05-06T05:18:20.784Z", 5 ] ] The values of the performance metric.
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF The ID of the request.

Examples

Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeDBClusterPerformance
  2. &DBClusterId=am-xxxxxxxxxx
  3. &StartTime=2019-11-01T00:00Z
  4. &EndTime=2019-11-01T00:05Z
  5. &Key=AnalyticDB_DiskUsage
  6. &<Common request parameters>

Sample success responses

XML format

  1. <DescribeDBClusterPerformanceResponse>
  2. <Performances>
  3. <Key>AnalyticDB_DiskUsage</Key>
  4. <Series>
  5. <Values>2019-11-11T00:00:27.862Z</Values>
  6. <Values>3.0026</Values>
  7. <Values>2019-11-11T00:00:57.867Z</Values>
  8. <Values>3.0026</Values>
  9. <Values>2019-11-11T00:01:27.873Z</Values>
  10. <Values>3.0026</Values>
  11. <Values>2019-11-11T00:01:57.878Z</Values>
  12. <Values>3.0026</Values>
  13. <Values>2019-11-11T00:02:27.884Z</Values>
  14. <Values>3.0026</Values>
  15. <Values>2019-11-11T00:02:57.889Z</Values>
  16. <Values>3.0026</Values>
  17. <Values>2019-11-11T00:03:27.896Z</Values>
  18. <Values>3.0026</Values>
  19. <Values>2019-11-11T00:03:57.901Z</Values>
  20. <Values>3.0026</Values>
  21. <Values>2019-11-11T00:04:27.907Z</Values>
  22. <Values>3.0026</Values>
  23. <Values>2019-11-11T00:04:57.912Z</Values>
  24. <Values>3.0026</Values>
  25. <Name>disk_used</Name>
  26. </Series>
  27. <Unit>%</Unit>
  28. </Performances>
  29. <RequestId>2271ADDE-1F5A-4501-8683-1667DF90504E</RequestId>
  30. <EndTime>2019-11-11T00:05:00Z</EndTime>
  31. <StartTime>2019-11-11T00:00:00Z</StartTime>
  32. </DescribeDBClusterPerformanceResponse>

JSON format

  1. {
  2. "Performances": [
  3. {
  4. "Key": "AnalyticDB_DiskUsage",
  5. "Series": [
  6. {
  7. "Values": [
  8. [
  9. "2019-11-11T00:00:27.862Z",
  10. "3.0026"
  11. ],
  12. [
  13. "2019-11-11T00:00:57.867Z",
  14. "3.0026"
  15. ],
  16. [
  17. "2019-11-11T00:01:27.873Z",
  18. "3.0026"
  19. ],
  20. [
  21. "2019-11-11T00:01:57.878Z",
  22. "3.0026"
  23. ],
  24. [
  25. "2019-11-11T00:02:27.884Z",
  26. "3.0026"
  27. ],
  28. [
  29. "2019-11-11T00:02:57.889Z",
  30. "3.0026"
  31. ],
  32. [
  33. "2019-11-11T00:03:27.896Z",
  34. "3.0026"
  35. ],
  36. [
  37. "2019-11-11T00:03:57.901Z",
  38. "3.0026"
  39. ],
  40. [
  41. "2019-11-11T00:04:27.907Z",
  42. "3.0026"
  43. ],
  44. [
  45. "2019-11-11T00:04:57.912Z",
  46. "3.0026"
  47. ]
  48. ],
  49. "Name": "disk_used"
  50. }
  51. ],
  52. "Unit": "%"
  53. }
  54. ],
  55. "RequestId": "2271ADDE-1F5A-4501-8683-1667DF90504E",
  56. "EndTime": "2019-11-11T00:05:00Z",
  57. "StartTime": "2019-11-11T00:00:00Z"
  58. }