DescribeDBNodePerformance - PolarDB - Alibaba Cloud Documentation Center

Queries the performance data of a node in 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.

Note By default, the monitoring data is collected once every 60 seconds. You can call the ModifyDBClusterMonitor operation to set the data collection interval to every 5 seconds.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBNodeId	string	Yes	The ID of the cluster node.	pi-*************
Interval	string	No	The interval at which performance data is collected. Valid values: 5 30 60 600 1800 3600 86400	60
Type	string	No	The 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 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 `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.	2020-09-23T01:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.	2020-09-23T01:01Z
DBClusterId	string	No	The cluster ID.	pc-****************

Response parameters

Parameter	Type	Description	Example
	object
PerformanceKeys	array<object>	The cluster performance metrics.
	object
MetricName	string	The name of the performance metric.	mean_sys_dir_size
Measurement	string	The performance metrics that you want to query.	PolarDBDiskUsage
Points	array<object>	The performance metrics.
	object
Value	string	The value of the metric.	9.33
Timestamp	long	The timestamp of the metric. This value is a UNIX timestamp. Unit: millisecond.	1600822800000
DBVersion	string	The version of the database engine.	8.0
EndTime	string	The end time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-09-23T01:01:00Z
RequestId	string	The request ID.	E2FDB684-751D-424D-98B9-704BEA******
StartTime	string	The start time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2020-09-23T01:00:00Z
DBType	string	The type of the database engine.	MySQL
DBNodeId	string	The ID of the cluster node.	pi-*****************

Examples

Sample success responses

JSONformat

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_sys_dir_size",
        "Measurement": "PolarDBDiskUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "9.33",
              "Timestamp": 1600822800000
            }
          ]
        }
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "E2FDB684-751D-424D-98B9-704BEA******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBType": "MySQL",
  "DBNodeId": "pi-*****************"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidKey.Malformed	The specified parameter Key is not valid.	The specified parameter key is invalid.
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidDateRange.Malformed	The Date Range can not more than one month.	The date range can be up to one month in length.
404	InvalidDBNodeId.NotFound	The DBNodeId provided does not exist in our records.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
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
2023-09-12	The Error code has changed	View Change Details
2023-06-12	The Error code has changed	View Change Details