Queries the performance data of a PolarDB cluster.
Operation description
-
When the monitoring data is collected every 5 seconds:
- If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
- If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
- If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
- If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
- When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
-
When the monitoring data is collected every 60 seconds:
- If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
- If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
- If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
- When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
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:DescribeDBClusterPerformance | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The cluster ID. | pc-**************** |
Type | string | No | The Query Type | orca |
Key | string | Yes | The performance metrics that you want to query. Separate multiple metrics with commas (,). For more information, see Performance parameters. Note
You can specify a maximum of five performance metrics.
| PolarDBDiskUsage |
StartTime | string | Yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the | 2020-09-23T01:01Z |
EndTime | string | Yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the | 2020-09-23T01:00Z |
Interval | string | No | The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds. | 60 |
Response parameters
Examples
Sample success responses
JSON
format
{
"PerformanceKeys": {
"PerformanceItem": [
{
"MetricName": "mean_data_size",
"Measurement": "PolarDBDiskUsage",
"Points": {
"PerformanceItemValue": [
{
"Value": "42.38",
"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 | InvalidKey.Malformed | The specified parameter Key is not valid. | The specified parameter key is invalid. |
400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | The specified EndTime parameter is invalid. |
400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | The specified StartTime parameter is invalid. |
400 | InvalidParameterCombination | The end time must be greater than the start time. | The end time must be later than the start time. |
400 | InvalidDateRange.Malformed | The Date Range can not more than one month. | The date range can be up to one month in length. |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-11 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2024-02-29 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-09-12 | The Error code has changed | View Change Details |