Queries the performance data of PolarProxy.

Note Only PolarDB for MySQL databases support this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBProxyPerformance

The operation that you want to perform. The operation that you want to perform. Set the value to DescribeDBProxyPerformance.

DBClusterId String Yes pc-****************

The ID of the cluster.

Key String Yes PolarProxy_CpuUsage

The performance metrics that you want to query. Separate multiple indicators with commas (,). For more information, see Performance parameters.

StartTime String Yes 2020-09-23T01:01Z

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

EndTime String Yes 2020-09-24T02:08Z

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Response parameters

Parameter Type Example Description
PerformanceKeys Array of PerformanceItem

The list of cluster performance items.

PerformanceItem
MetricName String service_connections_ps

The name of the performance metric.

Measurement String PolarProxy_CpuUsage

The performance metric.

Points Array of PerformanceItemValue

Details about the performance metric.

PerformanceItemValue
Value String 10

The value of the metric.

Timestamp Long 1600822800000

The time when the metric value was collected. This value is a timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

DBNodeId String pi-*************

The ID of the cluster node.

DBVersion String 8.0

The version of the database engine.

EndTime String 2020-09-23T01:01:00Z

The end of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String 35D3E3DA-4650-407A-BFF5-59BFF1******

The ID of the request.

StartTime String 2020-09-23T01:00:00Z

The beginning of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

DBClusterId String pc-*****************

The ID of the PolarDB cluster.

DBType String MySQL

The database engine that databases in the clusters run.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBProxyPerformance
&DBClusterId=pc-****************
&Key=PolarProxy_CpuUsage
&StartTime=2020-09-23T01:01Z
&EndTime=2020-09-24T02:08Z
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBProxyPerformanceResponse>
    <PerformanceKeys>
        <MetricName>service_connections_ps</MetricName>
        <Measurement>PolarProxy_CpuUsage</Measurement>
        <Points>
            <Value>10</Value>
            <Timestamp>1600822800000</Timestamp>
        </Points>
        <DBNodeId>pi-*************</DBNodeId>
    </PerformanceKeys>
    <DBVersion>8.0</DBVersion>
    <EndTime>2020-09-23T01:01:00Z</EndTime>
    <RequestId>35D3E3DA-4650-407A-BFF5-59BFF1******</RequestId>
    <StartTime>2020-09-23T01:00:00Z</StartTime>
    <DBClusterId>pc-*****************</DBClusterId>
    <DBType>MySQL</DBType>
</DescribeDBProxyPerformanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PerformanceKeys" : [ {
    "MetricName" : "service_connections_ps",
    "Measurement" : "PolarProxy_CpuUsage",
    "Points" : [ {
      "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

For a list of error codes, visit the API Error Center.