All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeDBClusterPerformance

Last Updated:Mar 03, 2024

Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range.

Operation description

You can query monitoring information only within the last 30 days.

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
gpdb:DescribeDBClusterPerformanceRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

Note You can call the DescribeDBInstances operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
gp-bp12ga6v69h86****
KeystringYes

The performance metric that you want to query. Separate multiple values with commas (,). For more information, see Performance parameters.

adbpg_conn_count
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDTHH:mmZ format.

Note You can query monitoring information only within the last 30 days.
2021-11-03T15:00Z
EndTimestringYes

The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDTHH:mmZ format.

Note The end time must be later than the start time. The maximum time range that can be specified is seven days.
2021-11-03T15:10Z
NodesstringNo

The nodes for which you want to query performance metrics. Separate multiple values with commas (,). Example: master-10******1,master-10******2. You can call the DescribeDBClusterNode operation to query the names of nodes.

You can also filter the nodes based on their metric values. Valid values:

  • top10: the 10 nodes that have the highest metric values.
  • top20: the 20 nodes that have the highest metric values.
  • bottom10: the 10 nodes that have the lowest metric values.
  • bottom20: the 20 nodes that have the lowest metric values.
top10
NodeTypestringNo

The node type. Valid values:

  • master: coordinator node.
  • segment: compute node.
Note If you do not specify this parameter, the performance metrics of all nodes are returned.
master

Response parameters

ParameterTypeDescriptionExample
object
PerformanceKeysobject []

The name of the performance metric. For more information, see Performance parameters.

Unitstring

The unit of the performance metric.

%
Seriesobject []

Details of the performance metric of a node.

Valuesobject []

The value of the performance metric collected at a point in time.

Pointarray

The value of the performance metric and the time when the metric value was collected.

string
["2021-11-03T15:00:00+08:00","5.84"]
Rolestring

The role of the node. Valid values:

  • master: primary coordinator node
  • standby: standby coordinator node
  • segment: compute node
standby
Namestring

The name of the compute node or compute group.

standby-********-cpu
Namestring

The name of the performance metric. For more information, see Performance parameters.

adbpg_group_cpu_used_percent
EndTimestring

The end time of the query. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mmZ format. The time is displayed in UTC.

2021-11-03T15:10Z
RequestIdstring

The request ID.

8E8990F0-C81E-4C94-8F51-5F**********
StartTimestring

The start time of the query. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mmZ format. The time is displayed in UTC.

2021-11-03T15:00Z
DBClusterIdstring

The instance ID.

gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "PerformanceKeys": [
    {
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[\"2021-11-03T15:00:00+08:00\",\"5.84\"]"
              ]
            }
          ],
          "Role": "standby",
          "Name": "standby-********-cpu"
        }
      ],
      "Name": "adbpg_group_cpu_used_percent"
    }
  ],
  "EndTime": "2021-11-03T15:10Z",
  "RequestId": "8E8990F0-C81E-4C94-8F51-5F**********",
  "StartTime": "2021-11-03T15:00Z",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-11The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupName