DescribeDBProxyPerformance - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeDBProxyPerformance operation to query the performance metrics of the database proxy for an ApsaraDB RDS instance.

Operation Description

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.

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	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The format in which the value of the performance metric is returned.	rm-t4n3axxxxx
DBProxyInstanceType	string	No	The operation that you want to perform. Set the value to DescribeDBProxyPerformance.	DedicatedProxy
StartTime	string	Yes	The 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-09-19T01:00:00Z
EndTime	string	Yes	The ID of the region where the instance resides. You can call the DescribeRegions operation to query the most recent region list.	2019-09-21T18:00:00Z
RegionId	string	Yes	The end of the time range that is queried.	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	An array that consists of the performance metrics that are returned.	normal

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	2019-09-21T18:00:00Z
StartTime	string	The name of the performance metric.	2019-09-19T01:00:00Z
DBInstanceId	string	An array that consists of the values of the performance metric in the following format: {value1, value2, ...}.	lsmexxxxxxx
RequestId	string	The beginning of the time range that is queried.	DD31056F-A0CE-41D7-AD39-689B6ABAE982
DBProxyEngineType	string	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.	normal
PerformanceKeys	object []	The ID of the instance.
ValueFormat	string	An internal parameter. You do not need to specify this parameter.	docker_container_cpu
Key	string	The ID of the request.	cpu_ratio

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.NotFound	The specified DB instance name does not exist.	The instance name does not exist.
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.
404	Endpoint.NotFound	Specified endpoint is not found.	The port that is associated with the dedicated proxy endpoint cannot be found.

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

Change history

Change time

Summary of changes

Operation

2022-06-23

API Description Update,The error codes of the API operation change.

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 404

2022-06-08

The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 404
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: DBProxyEngineType
Output Parameters	The response structure of the API operation changes.