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

There is currently no authorization information disclosed in the API.

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	array<object>	The performance list.
	object
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	array<object>	The performance metrics.
	object
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

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	View Change Details
2024-01-22	The Error code has changed	View Change Details
2024-01-16	The Error code has changed	View Change Details
2023-12-19	API Description Update. The Error code has changed	View Change Details
2022-06-23	API Description Update. The Error code has changed	View Change Details
2022-06-08	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details

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.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
403	ParamNotFound	The parameter is not found for the interface.	The parameter is not found for the interface.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
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.
404	Maxscale.NotFound	The relative maxscale instance is not found.	No associated maxscale instance is found.