DescribeApplicationPerformance - PolarDB - Alibaba Cloud Documentation Center

Queries the performance of a PolarDB AI application.

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

polardb:DescribeApplicationPerformance

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application cluster ID.	pa-**************
Key	string	Yes	The performance metrics to query. Separate multiple values with commas (,). Note You can specify up to 5 performance metrics.	PolarDBSupabaseMemUsage
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).	2020-09-23T01:01Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).	2020-09-23T01:00Z
Interval	string	No	The data granularity of performance data. Valid values: 5 30 60 600 1800 3600 86400	5
StartStep	integer	No	The start step number.	1
EndStep	integer	No	The end step number.	100
Downsample	string	No	The downsampling policy.	raw_sample
MaxPoints	integer	No	The maximum number of data points to return.	1000
Consumer	string	No	The user.	c-xxxxxxx
ConsumerGroup	string	No	The user group.	cg-xxxxxx
ModelService	string	No	The model service.	ms-xxxxxx
		No

Response elements

Element	Type	Description	Example
	object	The list of performance data.
PerformanceKeys	object
PerformanceItem	array<object>	The list of performance data.
	array<object>
MetricName	string	The metric name of the specific performance metrics.	mean_cpu_usage
Measurement	string	The performance metrics.	PolarDBSupabaseMemUsage
Points	object
PerformanceItemValue	array<object>	The list of performance data values.
	object	The list of performance data values.
Value	string	The data value.	42.38
Timestamp	integer	The specific point in time for the monitoring metrics. The value is in the UNIX timestamp format, in milliseconds.	1600822800000
Step	integer	The step size.	5
ComponentId	string	The component ID.	pac-xxx
ComponentType	string	The type of the component.	backend
EndTime	string	The end of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2025-05-23T02:21:00Z
RequestId	string	The request ID.	CDB3258F-B5DE-43C4-8935-CBA0CA******
StartTime	string	The beginning of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2022-11-15T16:00Z
ApplicationId	string	The application cluster ID.	pa-**************
ApplicationType	string	The application type.	supabase
Interval	string	The data granularity.	60

Examples

Success response

JSON format

{
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "mean_cpu_usage",
        "Measurement": "PolarDBSupabaseMemUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000,
              "Step": 5
            }
          ]
        },
        "ComponentId": "pac-xxx",
        "ComponentType": "backend"
      }
    ]
  },
  "EndTime": "2025-05-23T02:21:00Z",
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "StartTime": "2022-11-15T16:00Z",
  "ApplicationId": "pa-**************",
  "ApplicationType": "supabase",
  "Interval": "60"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidKey.Malformed	The specified parameter Key is not valid.	The specified parameter key is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidParameterCombination	The end time must be greater than the start time.	The end time must be later than the start time.
400	InvalidDateRange.Malformed	The Date Range can not more than one month.	The date range can be up to one month in length.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.