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

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

Operation description

You can query monitoring information 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 details of all AnalyticDB for PostgreSQL instances in a specified region, including the instance IDs.	gp-bp12ga6v69h86****
Key	string	Yes	The names of the performance metrics. Separate multiple metrics with commas (,). For more information, see Performance metric table.	adbpg_conn_count
StartTime	string	Yes	The start time of the query. Specify the time in the `YYYY-MM-DDTHH:mmZ` format. Note You can query monitoring information only for the last 30 days.	2021-11-03T15:00Z
EndTime	string	Yes	The end time of the query. Specify the time in the `YYYY-MM-DDTHH:mmZ` format. Note The end time must be later than the start time, and the time interval between the start time and the end time cannot exceed 7 days.	2021-11-03T15:10Z
Nodes	string	No	The names of the nodes for which you want to query monitoring metrics. Separate multiple node names with commas (,), such as `master-10****1,master-10**2`. You can call the DescribeDBClusterNode operation to obtain the node names. You can also filter nodes based on the values of monitoring metrics. Valid values: top10: The top 10 nodes with the highest monitoring metric values. top20: The top 20 nodes with the highest monitoring metric values. bottom10: The bottom 10 nodes with the lowest monitoring metric values. bottom20**: The bottom 20 nodes with the lowest monitoring metric values.	top10
NodeType	string	No	The node type. Valid values: master: Master node. segment: Segment node. Note If you do not specify this parameter, the monitoring 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 list of performance metric values for the instance.
	array<object>
Unit	string	The unit of the monitoring metrics.	%
Series	array<object>	The collection of performance metrics.
	array<object>
Values	array<object>	The performance metric values. Each value corresponds to a collection time point.
	object
Point	array	The performance metric value.
	string	The detailed performance monitoring information, which consists of the time and the performance metric value.	["2021-11-03T15:00:00+08:00","5.84"]
Role	string	The role of the node. Valid values: master: Master node. standby: Standby 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 metric table.	adbpg_group_cpu_used_percent
EndTime	string	The end time of the query in UTC. Specify the time in the `YYYY-MM-DDTHH:mmZ` format.	2021-11-03T15:10Z
RequestId	string	The request ID.	8E8990F0-C81E-4C94-8F51-5F**********
StartTime	string	The start time of the query in UTC. Specify the time in the `YYYY-MM-DDTHH:mmZ` format.	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.