AnalyticDB:DescribeDBClusterPerformance - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Queries the performance monitoring data of an AnalyticDB for PostgreSQL instance within a specified time range.

Operation description

Monitoring information can be queried only for the last 30 days.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:DescribeDBClusterPerformance

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances in a region.	gp-bp12ga6v69h86****
Key	string	Yes	The performance metric to query. Separate multiple values with commas (,). For more information, see Performance parameters.	adbpg_conn_count
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 is displayed in UTC. Note Only monitoring data within the last 30 days can be queried.	2021-11-03T15: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 is displayed in UTC. Note The end time must be later than the start time. The maximum query time range is seven days.	2021-11-03T15:10Z
Nodes	string	No	The nodes to query for performance metrics. Separate multiple values with commas (,). Example: `master-10****1,master-10**2`. You can call the DescribeDBClusterNode operation to query node names. You can also filter nodes by metric value. 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
NodeType	string	No	The node type. Valid values: master: coordinator node. segment: compute node. Note If you do not specify this parameter, performance metrics of all nodes are returned.	master
ResourceGroupName	string	No	The name of the resource group.	testgroup

Response elements

Element	Type	Description	Example
	object
PerformanceKeys	array<object>	The name of the performance metric. For more information, see Performance parameters.
	array<object>	The value of the performance metric and the time when the metric value was collected.
Unit	string	The unit of the performance metric.	%
Series	array<object>	The performance metric details of a node.
	array<object>
Values	array<object>	The value of the performance metric collected at a point in time.
	object
Point	array	The value of the performance metric and the time when the metric value was collected.
	string	Performance monitoring data, consisting of a timestamp and a metric value.	["2021-11-03T15:00:00+08:00","5.84"]
Role	string	The role of the node. Valid values: master: primary coordinator node standby: standby coordinator node segment: compute node	standby
Name	string	The name of the compute node or compute group.	standby-********-cpu
Name	string	The name of the performance metric. For more information, see Performance parameters.	adbpg_group_cpu_used_percent
EndTime	string	The end time of the query. The time is in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.	2021-11-03T15:10Z
RequestId	string	The request ID.	8E8990F0-C81E-4C94-8F51-5F**********
StartTime	string	The start time of the query. The time is in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The time is displayed in UTC.	2021-11-03T15:00Z
DBClusterId	string	The instance ID.	gp-bp12ga6v69h86****

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.