All Products
Search
Document Center

Database Autonomy Service:GetFullRequestSampleByInstanceId

更新時間:Sep 24, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:GetFullRequestSampleByInstanceIdget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserIdstringNo

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****
InstanceIdstringYes

The instance ID.

rm-2ze8g2am97624****
SqlIdstringYes

The SQL statement ID.

651b56fe9418d48edb8fdf0980ec****
StartlongYes

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
EndlongYes

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
RolestringNo

The role of the PolarDB-X 2.0 node. Valid values:

  • polarx_cn: compute node.
  • polarx_en: data node.
polarx_cn

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

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
RequestIdstring

The request ID.

0A74B755-98B7-59DB-8724-1321B394****
Dataarray<object>

The returned data.

Itemobject
Timestamplong

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
SqlIdstring

The SQL statement ID.

651b56fe9418d48edb8fdf0980ec****
Sqlstring

The sample SQL statement.

select * from testdb01 where ****
Databasestring

The name of the database.

dbtest
Rtdouble

The amount of time consumed to execute the SQL statement. Unit: seconds.

0.409789
Userstring

The name of the user who executes the SQL statement.

testuser
LockWaitTimedouble

The lock wait duration. Unit: seconds.

0.0137
LogicalReaddouble

The number of logical reads.

165848
PhysicalSyncReaddouble

The number of physical synchronous reads.

0
PhysicalAsyncReaddouble

The number of physical asynchronous reads.

0
RowsExaminedlong

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
RowsReturnedlong

The number of rows returned by the SQL statement.

14
OriginHoststring

The source IP address.

172.17.XX.XX
ScanRowslong

The number of scanned rows.

0
UpdateRowslong

The number of updated rows.

0
SqlTypestring

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
Scntlong

The number of requests sent from PolarDB-X 2.0 compute nodes to data nodes.

0
Rowslong

The number of rows updated or returned on PolarDB-X 2.0 compute nodes.

0
Frowslong

The number of rows fetched by PolarDB-X 2.0 compute nodes.

0
Codelong

The HTTP status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
2022-08-15Add OperationView Change Details