Queries the performance metrics of an instance.
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 |
---|---|---|---|---|
rds:DescribeDBInstancePerformance | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
Key | string | Yes | The performance metrics that you want to query. Separate multiple values with commas (,). You can specify up to 30 values. For more information, see Performance parameters. Note
If you set Key to MySQL_SpaceUsage or SQLServer_SpaceUsage, you can query the monitoring data within only one day.
| MySQL_Sessions |
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. Note
The time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.
| 2012-06-08T15: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. Note
The time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.
| 2012-06-18T15:00Z |
NodeId | string | No | The ID of the instance. | 339**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndTime": "2012-06-19T15:00Z",
"StartTime": "2012-06-10T15:00Z",
"DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"Engine": "MySQL",
"RequestId": "A5409D02-D661-4BF3-8F3D-0A814D0574E7",
"PerformanceKeys": {
"PerformanceKey": [
{
"Key": "MySQL_Sessions",
"ValueFormat": "recv_k&sent_k",
"Unit": "KB",
"Values": {
"PerformanceValue": [
{
"Date": "2011-05-30T03:29:00Z",
"Value": "0.0&13.6"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|