DescribeRDSPerformance - PolarDB - Alibaba Cloud Documentation Center

Queries the performance data of an ApsaraDB RDS instance at the storage layer by calling the DescribeRDSPerformance operation.

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

drds:DescribeRDSPerformance

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	Instance ID of the DRDS instance..	drds*********
RdsInstanceId	string	Yes	The instance ID of the ApsaraDB RDS instance at the storage layer.	rm-************
Keys	string	Yes	The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,). Note For more information about performance monitoring metrics, see Storage monitoring.	MySQL_MemCpuUsage
StartTime	integer	No	The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.	1603123290000
EndTime	integer	No	The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.	1603209690000
DbInstType	string	No	The database engine type.	mysql

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	DB53EC68-463C-4187-8D2B-C2AD8C******
Data	array<object>	The query result set.
	array<object>
Key	string	The name of the monitoring metrics.	cpuusage
NodeName	string	The node name. Note This parameter is returned only when the database storage type is PolarDB for MySQL. This parameter is not returned for ApsaraDB RDS for MySQL.	pi-*************
Unit	string	The unit of the monitoring metrics.	%
NodeNum	integer	The number of nodes.	1
Values	array<object>	The details of the monitoring metrics data.
	object
Date	integer	The time point when the value of the monitoring metric was obtained. The value is in the UNIX timestamp format. The time is displayed in UTC. Unit: ms.	1603209660000
Value	string	The value of the monitoring metric.	0.58

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "DB53EC68-463C-4187-8D2B-C2AD8C******",
  "Data": [
    {
      "Key": "cpuusage",
      "NodeName": "pi-*************",
      "Unit": "%",
      "NodeNum": 1,
      "Values": [
        {
          "Date": 1603209660000,
          "Value": "0.58"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.
404	Monitor.QueryRdsFailure	Failed to query RDS monitor info.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.