GetPfsSqlSample - Database Autonomy Service - Alibaba Cloud Documentation Center

Queries the SQL sample data 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 API operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call API 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).

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 instances and PolarDB for MySQL clusters are supported	rm-2ze1jdv45i7l6****
NodeId	string	No	The node ID. Note For ApsaraDB RDS for MySQL Cluster Edition instances or PolarDB for MySQL clusters, you must specify the node ID.	r-x****-db-0
SqlId	string	No	The SQL ID.	651b56fe9418d48edb8fdf0980ec****
StartTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676511134614
EndTime	integer	Yes	The end of the time range to query. The value is 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.	1678074351197

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
Code	integer	The HTTP status code returned.	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 SQL sample data.
	object
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 ID of the logical database.	xxxxx
Timestamp	integer	The time when the SQL statement was executed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1660100753556
SqlId	string	The SQL statement ID.	651b56fe9418d48edb8fdf0980ec****
Sql	string	The sample SQL statement.	select * from xxxx where ****
ThreadId	integer	The thread ID.	81751940
EventId	integer	The event ID.	63735293
EndEventId	integer	The end ID of the event. By default, the value of this parameter is NULL when the event starts and is changed to the event ID when the event ends.	0
EventName	string	The name of the event.	statement/sql/select
Latency	number	The execution duration. Unit: millisecond.	0.199
LockLatency	number	The lock wait duration. Unit: millisecond.	0.09
Errors	integer	The number of errors returned for the SQL statement.	0
Warnings	integer	The number of warnings returned for the SQL statement.	0
RowsAffected	integer	The number of rows affected by the SQL statement.	0
RowsSent	integer	The number of rows returned by the SQL statement.	0
RowsExamined	integer	The number of rows scanned by the SQL statement.	2048576
CreateTmpDiskTables	integer	The number of internal on-disk temporary tables that were created when the SQL statement was executed.	0
CreateTmpTables	integer	The number of internal temporary tables that were created when the SQL statement was executed.	0
SelectFullJoin	integer	The number of joins that are used to perform table scans without using indexes. Note : This parameter is used for the scenario in which indexes are not used in a union query. If the returned value is not 0, check the indexes of tables.	0
SelectFullRangeJoin	integer	The number of joins that used ranges on referenced tables.	0
SelectRange	integer	The number of joins that used ranges on the first table.	0
SelectRangeCheck	integer	The number of joins that did not have key values. The keys and values were checked for each row of data. Note : This parameter is used for the scenario in which indexes are not used in a union query. If the returned value is not 0, check the indexes of tables.	0
SelectScan	integer	The number of scans.	0
SortMergePasses	integer	The number of merges that the sorting algorithm must perform.	0
SortRange	integer	The number of times the data was sorted by using ranges.	0
SortRows	integer	The number of sorted rows.	0
SortScan	integer	The number of sorts that were performed during table scans.	1
NoIndexUsed	integer	Indicates whether table scans were performed when indexes were not used. Valid values: 1: yes. 0: no.	1
NoGoodIndexUsed	integer	Indicates whether the server failed to find an index that can be used for the SQL statement. Valid values: 1: yes. 0: no.	1
Db	string	The name of the database.	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.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.