Queries the performance data of PolarProxy.
Operation description
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:DescribeDBProxyPerformance | get |
|
| 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 | 2020-09-23T01:01Z |
EndTime | string | Yes | The end of the time range to query. Specify the time in the | 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 parameters
Examples
Sample success responses
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. |
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 |