All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceMetrics

Last Updated:May 11, 2024

Queries the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance.

Operation description

Supported database engines

  • PostgreSQL

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

View the Enhanced Monitoring metrics

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDBInstanceMetricsRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceNamestringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

pgm-bp1s1j103lo6****
ResourceGroupIdstringNo

The resource group ID.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalRecordCountinteger

The total number of enhanced monitoring metrics that are enabled for the instance.

1
RequestIdstring

The ID of the request.

318C3754-F6D0-54BB-A55C-23EAA04708B7
Itemsobject []

An array consisting of the Enhanced Monitoring metrics that are enabled for the instance.

GroupKeystring

The key of the group to which the enhanced monitoring metric belongs.

os.cpu_usage
SortRuleinteger

The serial number of the enhanced monitoring metric.

1
Descriptionstring

The description of the enhanced monitoring metric.

OS CPU utilization, equal to the number of OS-consumed CPUs divided by the total number of CPUs
Unitstring

The unit of the enhanced monitoring metric.

%
MetricsKeystring

The key of the enhanced monitoring metric.

os.cpu_usage.sys.avg
GroupKeyTypestring

The name of the group to which the enhanced monitoring metric belongs.

CPU Utilization Rate
Methodstring

The method that is used to aggregate the monitoring data of the enhanced monitoring metric. Valid values:

  • avg: The system calculates the average value of the enhanced monitoring metric.
  • min: The system calculates the minimum value of the enhanced monitoring metric.
  • max: The system calculates the maximum value of the enhanced monitoring metric.
avg
Dimensionstring

The category of the enhanced monitoring metric. Valid values:

  • os: OS metric
  • db: database metric
os
MetricsKeyAliasstring

The alias of the enhanced monitoring metric.

os.cpu_usage.sys
DBInstanceNamestring

The instance ID.

rm-bp1*****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidInstanceMetricsConfigs.NotFoundThe specified instance has no metrics configsThe specified instance does not have performance metric configurations.
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
404InvalidDBInstanceName.NotFoundThe 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 timeSummary of changesOperation
2022-08-04The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.