DescribeDBProxyPerformance - PolarDB - Alibaba Cloud Documentation Center

Queries the performance data of PolarProxy.

Operation description

Note This operation is applicable only to PolarDB for MySQL clusters.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of cluster.	pc-****************
DBEndpointId	string	No	The ID of the endpoint.	pe-****************
Interval	string	No	The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds.	60
Type	string	No	Special metric. Set the value to tair, which indicates the PolarTair architecture.	tair
Key	string	Yes	The performance metrics that you want to query. Separate multiple indicators with commas (,). For more information, see Performance parameters.	PolarProxy_CpuUsage
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.	2020-09-23T01:01Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.	2020-09-24T02:08Z
DBNodeId	string	No	Database instance node ID. Note It is used to query the metrics of Proxy on different DB nodes, supporting metrics such as PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.	pi-******************

Response parameters

Parameter	Type	Description	Example
	object
PerformanceKeys	array<object>	Details about the performance metrics.
PerformanceItem	object
MetricName	string	The name of the performance metric.	service_connections_ps
Measurement	string	The performance metric.	PolarProxy_CpuUsage
Points	array<object>	The list of the performance metrics.
PerformanceItemValue	object
Value	string	The value of the metric.	10
Timestamp	long	The time when the metric value was collected. This value is a timestamp in milliseconds.	1600822800000
DBNodeId	string	The ID of the node.	pi-*************
DBVersion	string	The version of the database engine.	8.0
EndTime	string	The end time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-09-23T01:01:00Z
RequestId	string	The ID of the request.	35D3E3DA-4650-407A-BFF5-59BFF1******
StartTime	string	The start time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-09-23T01:00:00Z
DBClusterId	string	The ID of the cluster.	pc-*****************
DBType	string	The type of the database engine.	MySQL

Examples

Sample success responses

JSONformat

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "service_connections_ps",
        "Measurement": "PolarProxy_CpuUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "10",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterCombination	The end time must be greater than the start time.	The end time must be later than the start time.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidKey.Malformed	The specified parameter Key is not valid.	The specified parameter key is invalid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBEndpointId.NotFound	The DBEndpointId provided does not exist in our records.	The supplied DBEndpointId does not exist in the current record.

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

Change history

Change time	Summary of changes	Operation
2024-08-27	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-03-14	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-03-13	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-02-02	The Error code has changed. The request parameters of the API has changed	View Change Details