DescribeDBProxyPerformance-阿里云帮助中心

Queries the performance data of PolarProxy.

Operation description

Note

This operation is applicable only to PolarDB for MySQL clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBProxyPerformance

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

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	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 elements

Element	Type	Description	Example
	object
PerformanceKeys	object
PerformanceItem	array<object>	Details about the performance metrics.
	array<object>
MetricName	string	The name of the performance metric.	service_connections_ps
Measurement	string	The performance metric.	PolarProxy_CpuUsage
Points	object
PerformanceItemValue	array<object>	The list of the performance metrics.
	object
Value	string	The value of the metric.	10
Timestamp	integer	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.