GetPfsMetricTrends - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the trend of a metric for the new version of the performance insight feature of a database instance.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
An ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster is connected to DAS.
The new version of the performance insight feature is enabled for the database instance. For more information, see Performance insight (new version).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
hdm:GetPfsMetricTrends	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	rm-m5ea73876ukci****
NodeId	string	No	The node ID. Note This parameter is required if the database instance is an ApsaraDB RDS for MySQL Cluster Edition instance or a PolarDB for MySQL clusters.	r-x****-db-0
Metric	string	No	The metric whose trend you want to query. Valid values: count: the number of executions. avgRt: the average execution duration. rtRate: the execution duration percentage. rowsExamined: the total number of scanned rows.	Count
StartTime	long	No	The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1677461663092
EndTime	long	No	The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The end time must be later than the start time. You can view the data of up to seven days in the previous 30 days.	1678432430967

Response parameters

Parameter	Type	Description	Example
	object
Code	long	The HTTP status code returned.	200
Data	object	The data returned.
	array<object>	The details of the data returned.
	object
Timestamp	string	The timestamp. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1681975870000
Value	any	The value of the metric.	478.28
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	F4C27966-284E-51C4-9407-DB50CAB8****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Data": {
    "key": [
      {
        "Timestamp": "1681975870000",
        "Value": "478.28"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "F4C27966-284E-51C4-9407-DB50CAB8****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation

No change history