Retrieve SQL Samples Fast by Instance ID with DAS API - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Queries SQL sample data from the SQL Explorer results of a database instance by SQL ID by calling the GetFullRequestSampleByInstanceId operation. A maximum of 20 sample records are returned.

Operation description

The SQL Explorer feature allows you to diagnose SQL health and troubleshoot performance issues. For details, see SQL Explorer.

For information about supported database engines, see SQL Explorer.
When you use an SDK to invoke DAS, set the region to cn-shanghai.

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:GetFullRequestSampleByInstanceId

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
SqlId	string	Yes	SQL ID。	651b56fe9418d48edb8fdf0980ec****
Start	integer	Yes	The beginning of the time range to query. Specify a UNIX timestamp in milliseconds. Note The start time must be within the storage duration of SQL Explorer for the database instance and cannot be earlier than 90 days before the current time.	1660097421000
End	integer	Yes	The end of the time range to query. Specify a UNIX timestamp in milliseconds. Note The end time must be later than the start time, and the interval between the start time and end time cannot be less than 1 hour.	1660104621000
Role	string	No	The node information of a PolarDB-X 2.0 database instance. polarx_cn: compute node. polarx_en: data node.	polarx_cn

Response elements

Element	Type	Description	Example
	object
Code	integer	The response status code.	200
Data	array<object>	The returned data.
	object
Database	string	The database name.	dbtest
Frows	integer	The number of rows fetched by the PolarDB-X 2.0 compute node (CN).	0
LockWaitTime	number	The lock wait duration. Unit: seconds.	0.0137
LogicalRead	number	The number of logical reads.	165848
OriginHost	string	The source of the access.	172.17.XX.XX
PhysicalAsyncRead	number	The number of physical asynchronous reads.	0
PhysicalSyncRead	number	The number of physical synchronous reads.	0
Rows	integer	The number of rows updated or returned by the PolarDB-X 2.0 compute node (CN).	0
RowsExamined	integer	The total number of rows examined. Note Currently, the following databases support this field: ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL.	2048576
RowsReturned	integer	The number of rows returned.	14
Rt	number	The execution duration. Unit: seconds.	0.409789
ScanRows	integer	The number of rows scanned.	0
Scnt	integer	The number of DN requests from the PolarDB-X 2.0 compute node (CN).	0
Sql	string	The SQL sample.	select * from testdb01 where ****
SqlId	string	SQL ID。	651b56fe9418d48edb8fdf0980ec****
SqlType	string	The type of the SQL statement. Valid values: SELECT, INSERT, UPDATE, DELETE, LOGIN, LOGOUT, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE, DROP, SET, DESC, REPLACE, CALL, BEGIN, DESCRIBE, ROLLBACK, FLUSH, USE, SHOW, START, COMMIT, and RENAME.	SELECT
Timestamp	integer	The time when the SQL statement was executed. The value is a UNIX timestamp in milliseconds.	1660100753556
UpdateRows	integer	The number of rows updated.	0
User	string	The username that executed the SQL statement.	testuser
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.	Successful
RequestId	string	The request ID.	0A74B755-98B7-59DB-8724-1321B394****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Data": [
    {
      "Database": "dbtest",
      "Frows": 0,
      "LockWaitTime": 0.0137,
      "LogicalRead": 165848,
      "OriginHost": "172.17.XX.XX",
      "PhysicalAsyncRead": 0,
      "PhysicalSyncRead": 0,
      "Rows": 0,
      "RowsExamined": 2048576,
      "RowsReturned": 14,
      "Rt": 0.409789,
      "ScanRows": 0,
      "Scnt": 0,
      "Sql": "select * from testdb01 where ****",
      "SqlId": "651b56fe9418d48edb8fdf0980ec****",
      "SqlType": "SELECT",
      "Timestamp": 1660100753556,
      "UpdateRows": 0,
      "User": "testuser"
    }
  ],
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true
}

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.