GetFullRequestSampleByInstanceId - Database Autonomy Service

Queries sample SQL statements in the SQL Explorer data of a database instance by SQL ID. You can query up to 20 sample SQL statements.

Operation description

The SQL Explorer feature allows you to check the health status of SQL statements and troubleshoot performance issues. For more information, see SQL Explorer.

For more information about the database engines that support SQL Explorer, see SQL Explorer.
If you use an SDK to call API operations of DAS, you must set the region ID 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
UserId	string	No	The ID of the Alibaba Cloud account that is used to create the database instance. Note This parameter is optional. The system can automatically obtain the account ID based on the value of InstanceId when you call this operation.	196278346919****
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
SqlId	string	Yes	The SQL statement ID.	651b56fe9418d48edb8fdf0980ec****
Start	integer	Yes	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. Note The start time must be within the storage duration of the SQL Explorer feature of the database instance, and can be up to 90 days earlier than the current time.	1660097421000
End	integer	Yes	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. The interval between the start time and the end time must be equal to or greater than 1 hour.	1660104621000
Role	string	No	The role of the PolarDB-X 2.0 node. Valid values: polarx_cn: compute node. polarx_en: data node.	polarx_cn

Response elements

Element	Type	Description	Example
	object
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message that contains information such as an error code is returned.	Successful
RequestId	string	The request ID.	0A74B755-98B7-59DB-8724-1321B394****
Data	array<object>	The returned data.
	object
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 testdb01 where ****
Database	string	The name of the database.	dbtest
Rt	number	The amount of time consumed to execute the SQL statement. Unit: seconds.	0.409789
User	string	The name of the user who executes the SQL statement.	testuser
LockWaitTime	number	The lock wait duration. Unit: seconds.	0.0137
LogicalRead	number	The number of logical reads.	165848
PhysicalSyncRead	number	The number of physical synchronous reads.	0
PhysicalAsyncRead	number	The number of physical asynchronous reads.	0
RowsExamined	integer	The total number of scanned rows. Note This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	2048576
RowsReturned	integer	The number of rows returned by the SQL statement.	14
OriginHost	string	The source IP address.	172.17.XX.XX
ScanRows	integer	The number of scanned rows.	0
UpdateRows	integer	The number of updated rows.	0
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
Scnt	integer	The number of requests sent from PolarDB-X 2.0 compute nodes to data nodes.	0
Rows	integer	The number of rows updated or returned on PolarDB-X 2.0 compute nodes.	0
Frows	integer	The number of rows fetched by PolarDB-X 2.0 compute nodes.	0
Code	integer	The HTTP status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

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

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.