Queries the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL 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:DescribeDBInstanceMetrics | get | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceName | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | pgm-bp1s1j103lo6**** |
ResourceGroupId | string | No | The resource group ID. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalRecordCount": 1,
"RequestId": "318C3754-F6D0-54BB-A55C-23EAA04708B7",
"Items": [
{
"GroupKey": "os.cpu_usage",
"SortRule": 1,
"Description": "OS CPU utilization, equal to the number of OS-consumed CPUs divided by the total number of CPUs\n",
"Unit": "%",
"MetricsKey": "os.cpu_usage.sys.avg",
"GroupKeyType": "CPU Utilization Rate\n",
"Method": "avg",
"Dimension": "os",
"MetricsKeyAlias": "os.cpu_usage.sys"
}
],
"DBInstanceName": "rm-bp1*****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidInstanceMetricsConfigs.NotFound | The specified instance has no metrics configs | The specified instance does not have performance metric configurations. |
400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-11-18 | API Description Update. The Error code has changed | View Change Details |
2022-08-04 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |