Call GetPfsSqlSample to query SQL sample data - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Retrieves the SQL sample data for the Performance Insight (New Version) feature.

Operation description

Before you call this operation, ensure that the following prerequisites are met:

If you use the Alibaba Cloud SDK or the DAS SDK, use the latest version.
When you use the SDK to call DAS, set the region to cn-shanghai.
The destination database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster.
The Performance Insight (New Version) feature is enabled for the destination database instance. For more information, see Performance Insight (New Version).

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

hdm:GetPfsSqlSample

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. Note Only ApsaraDB RDS for MySQL and PolarDB for MySQL instances are supported.	rm-2ze1jdv45i7l6****
NodeId	string	No	The node ID. Note For an ApsaraDB RDS for MySQL Cluster Edition instance or a PolarDB for MySQL cluster, you must specify the node ID.	r-x****-db-0
SqlId	string	No	The SQL ID.	651b56fe9418d48edb8fdf0980ec****
StartTime	integer	Yes	The start time of the query. The time is a UNIX timestamp in milliseconds.	1676511134614
EndTime	integer	Yes	The end time of the query. The time is a UNIX timestamp in milliseconds. Note The end time must be later than the start time. You can query data for up to seven days within the last month.	1678074351197

Response elements

Element	Type	Description	Example
	object	The response data.
Message	string	The message returned for the request. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
Code	integer	The returned status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	array<object>	The returned SQL sample data.
	object	The returned data.
UserId	string	The user ID.	196278346919****
InstanceId	string	The instance ID.	rm-2ze1jdv45i7l6****
NodeId	string	The node ID. Note This parameter is returned only for ApsaraDB RDS for MySQL Cluster Edition instances or PolarDB for MySQL clusters.	r-x****-db-0
LogicId	string	The logical database ID.	xxxxx
Timestamp	integer	The time when the SQL statement was executed. The time is a UNIX timestamp in milliseconds.	1660100753556
SqlId	string	The SQL ID.	651b56fe9418d48edb8fdf0980ec****
Sql	string	The SQL sample.	select * from xxxx where ****
ThreadId	integer	The thread ID.	81751940
EventId	integer	The event ID.	63735293
EndEventId	integer	The end event ID. This parameter is NULL by default when the event starts and is updated to the current event ID of the thread when the event ends.	0
EventName	string	The event name.	statement/sql/select
Latency	number	The execution duration, in milliseconds.	0.199
LockLatency	number	The lock wait time, in milliseconds.	0.09
Errors	integer	The number of errors in the SQL statement.	0
Warnings	integer	The number of warnings for the SQL statement.	0
RowsAffected	integer	The number of affected rows.	0
RowsSent	integer	The number of rows returned by the SQL statement.	0
RowsExamined	integer	The number of scanned rows.	2048576
CreateTmpDiskTables	integer	The number of on-disk internal temporary tables created during statement execution.	0
CreateTmpTables	integer	The number of internal temporary tables created during statement execution.	0
SelectFullJoin	integer	The number of joins that perform table scans without using indexes. Important This parameter counts the joins that do not use indexes during a join query. If the value is not 0, check the table indexes.	0
SelectFullRangeJoin	integer	The number of joins that use a range search on a reference table.	0
SelectRange	integer	The number of joins that use a range on the first table.	0
SelectRangeCheck	integer	The number of joins without keys that check for key usage after each row. Important This parameter counts the joins that do not use indexes during a join query. If the value is not 0, check the table indexes.	0
SelectScan	integer	The number of scans.	0
SortMergePasses	integer	The number of merge passes that the sort algorithm must perform.	0
SortRange	integer	The number of sorts that use a range.	0
SortRows	integer	The number of sorted rows.	0
SortScan	integer	The number of sort scans.	1
NoIndexUsed	integer	Indicates whether the statement performed a table scan without using an index. Valid values: 1: Yes. 0: No.	1
NoGoodIndexUsed	integer	Indicates whether the server could not find a good index to use for the statement. Valid values: 1: Yes. 0: No.	1
Db	string	The database name.	testDB

Examples

Success response

JSON format

{
  "Message": "Successful",
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "UserId": "196278346919****",
      "InstanceId": "rm-2ze1jdv45i7l6****",
      "NodeId": "r-x****-db-0",
      "LogicId": "xxxxx",
      "Timestamp": 1660100753556,
      "SqlId": "651b56fe9418d48edb8fdf0980ec****",
      "Sql": "select * from xxxx where ****",
      "ThreadId": 81751940,
      "EventId": 63735293,
      "EndEventId": 0,
      "EventName": "statement/sql/select",
      "Latency": 0.199,
      "LockLatency": 0.09,
      "Errors": 0,
      "Warnings": 0,
      "RowsAffected": 0,
      "RowsSent": 0,
      "RowsExamined": 2048576,
      "CreateTmpDiskTables": 0,
      "CreateTmpTables": 0,
      "SelectFullJoin": 0,
      "SelectFullRangeJoin": 0,
      "SelectRange": 0,
      "SelectRangeCheck": 0,
      "SelectScan": 0,
      "SortMergePasses": 0,
      "SortRange": 0,
      "SortRows": 0,
      "SortScan": 1,
      "NoIndexUsed": 1,
      "NoGoodIndexUsed": 1,
      "Db": "testDB"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.