DescribeDBProxyPerformance - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the performance data of the database proxy for an instance.

Operation description

Supported database engines

MySQL
PostgreSQL

Note Starting October 17, 2023, ApsaraDB RDS provides a dedicated proxy free of charge for each ApsaraDB RDS for MySQL instance on RDS Cluster Edition. For more information, see [Special offers/Price changes] One proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition.

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeDBProxyPerformance	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-t4n3axxxxx
DBProxyInstanceType	string	No	The type of the database proxy instance. Valid values: common: the general-purpose database proxy exclusive: the dedicated database proxy	DedicatedProxy
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-09-19T01:00:00Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-09-21T18:00:00Z
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
MetricsName	string	Yes	The performance metrics that you want to query. If the instance runs MySQL, you can query only the Maxscale_CpuUsage performance metric, which indicates the CPU utilization of the instance. If the instance runs PostgreSQL, you can query the following performance metrics: Maxscale_TotalConns: the number of connections per second Maxscale_CurrentConns: the number of connections that are established Maxscale_DownFlows: outbound traffic Maxscale_UpFlows: inbound traffic Maxscale_QPS: QPS Maxscale_MemUsage: memory usage Maxscale_CpuUsage: CPU utilization If you want to query more than one performance metric, separate the performance metrics with commas (,). You can specify up to six performance metrics in a single request.	Maxscale_CpuUsage
DBProxyEngineType	string	No	A reserved parameter. You do not need to specify this parameter.	normal

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
EndTime	string	The end time of the query.	2019-09-21T18:00:00Z
StartTime	string	The start time of the query.	2019-09-19T01:00:00Z
DBInstanceId	string	The instance ID.	lsmexxxxxxx
RequestId	string	The request ID.	DD31056F-A0CE-41D7-AD39-689B6ABAE982
DBProxyEngineType	string	An internal parameter. You do not need to specify this parameter.	normal
PerformanceKeys	object []	The performance list.
ValueFormat	string	The format in which the value of the performance metric is returned.	docker_container_cpu
Key	string	The performance parameter.	cpu_ratio
Values	object []	The performance metrics.
Date	string	The date and time when the value of the performance metric was recorded. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-10-10T09:00:00Z
Value	string	The value of the performance metric.	2.83

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-09-21T18:00:00Z",
  "StartTime": "2019-09-19T01:00:00Z",
  "DBInstanceId": "lsmexxxxxxx",
  "RequestId": "DD31056F-A0CE-41D7-AD39-689B6ABAE982",
  "DBProxyEngineType": "normal",
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "ValueFormat": "docker_container_cpu",
        "Key": "cpu_ratio",
        "Values": {
          "PerformanceValue": [
            {
              "Date": "2019-10-10T09:00:00Z",
              "Value": "2.83"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
403	ParamNotFound	The parameter is not found for the interface.	The parameter is not found for the interface.
404	Endpoint.NotFound	Specified endpoint is not found.	The port that is associated with the dedicated proxy endpoint cannot be found.
404	InvalidDBInstanceName.NotFound	The DBInstanceId provided does not exist in our records.	The instance ID cannot be found.

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

Change history

Change time

Summary of changes

Operation

2024-04-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 403

2024-01-22

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	Error Codes 404 change
	delete Error Codes: 403

2024-01-16

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 403

2023-12-19

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	Added Error Codes: 403

2022-06-23

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404

2022-06-08

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: DBProxyEngineType
Output Parameters	The response structure of the API has changed.