All Products
Search
Document Center

PolarDB:DescribeDBProxyPerformance

Last Updated:Nov 13, 2024

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.

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
polardb:DescribeDBProxyPerformanceget
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of cluster.

pc-****************
DBEndpointIdstringNo

The ID of the endpoint.

pe-****************
IntervalstringNo

The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds.

60
TypestringNo

Special metric. Set the value to tair, which indicates the PolarTair architecture.

tair
KeystringYes

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

PolarProxy_CpuUsage
StartTimestringYes

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
EndTimestringYes

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
DBNodeIdstringNo

The ID of the node in the cluster. This parameter can be used to query the performance metrics of PolarProxy on different nodes. The following metrics are supported: PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.

pi-******************

Response parameters

ParameterTypeDescriptionExample
object
PerformanceKeysarray<object>

Details about the performance metrics.

PerformanceItemobject
MetricNamestring

The name of the performance metric.

service_connections_ps
Measurementstring

The performance metric.

PolarProxy_CpuUsage
Pointsarray<object>

The list of the performance metrics.

PerformanceItemValueobject
Valuestring

The value of the metric.

10
Timestamplong

The time when the metric value was collected. This value is a timestamp in milliseconds.

1600822800000
DBNodeIdstring

The ID of the node.

pi-*************
DBVersionstring

The version of the database engine.

8.0
EndTimestring

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
RequestIdstring

The ID of the request.

35D3E3DA-4650-407A-BFF5-59BFF1******
StartTimestring

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
DBClusterIdstring

The ID of the cluster.

pc-*****************
DBTypestring

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 codeError codeError messageDescription
400InvalidParameterCombinationThe end time must be greater than the start time.The end time must be later than the start time.
400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.The specified StartTime parameter is invalid.
400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.The specified EndTime parameter is invalid.
400InvalidKey.MalformedThe specified parameter Key is not valid.The specified parameter key is invalid.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBEndpointId.NotFoundThe 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 timeSummary of changesOperation
2024-08-27The Error code has changed. The request parameters of the API has changedView Change Details
2024-03-14The Error code has changed. The request parameters of the API has changedView Change Details
2024-03-13The Error code has changed. The request parameters of the API has changedView Change Details
2024-02-02The Error code has changed. The request parameters of the API has changedView Change Details