All Products
Search

This Product

    Database Autonomy Service:GetPfsSqlSample

    Document Center

    Database Autonomy Service:GetPfsSqlSample

    Last Updated:Apr 25, 2024

    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).

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The instance ID.

    Note Only ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters are supported
    		rm-2ze1jdv45i7l6****
    NodeIdstringNo

    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
    SqlIdstringNo

    The SQL ID.

    		651b56fe9418d48edb8fdf0980ec****
    StartTimelongYes

    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
    EndTimelongYes

    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 parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    Messagestring

    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
    RequestIdstring

    The request ID.

    		9CB97BC4-6479-55D0-B9D0-EA925AFE****
    Codelong

    The HTTP status code returned.

    		200
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    Dataobject []

    The SQL sample data.

    UserIdstring

    The user ID.

    		196278346919****
    InstanceIdstring

    The instance ID.

    		rm-2ze1jdv45i7l6****
    NodeIdstring

    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
    LogicIdstring

    The ID of the logical database.

    		xxxxx
    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 xxxx where ****
    ThreadIdinteger

    The thread ID.

    		81751940
    EventIdinteger

    The event ID.

    		63735293
    EndEventIdinteger

    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
    EventNamestring

    The name of the event.

    		statement/sql/select
    Latencydouble

    The execution duration. Unit: millisecond.

    		0.199
    LockLatencydouble

    The lock wait duration. Unit: millisecond.

    		0.09
    Errorsinteger

    The number of errors returned for the SQL statement.

    		0
    Warningsinteger

    The number of warnings returned for the SQL statement.

    		0
    RowsAffectedinteger

    The number of rows affected by the SQL statement.

    		0
    RowsSentinteger

    The number of rows returned by the SQL statement.

    		0
    RowsExaminedinteger

    The number of rows scanned by the SQL statement.

    		2048576
    CreateTmpDiskTablesinteger

    The number of internal on-disk temporary tables that were created when the SQL statement was executed.

    		0
    CreateTmpTablesinteger

    The number of internal temporary tables that were created when the SQL statement was executed.

    		0
    SelectFullJoininteger

    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
    SelectFullRangeJoininteger

    The number of joins that used ranges on referenced tables.

    		0
    SelectRangeinteger

    The number of joins that used ranges on the first table.

    		0
    SelectRangeCheckinteger

    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
    SelectScaninteger

    The number of scans.

    		0
    SortMergePassesinteger

    The number of merges that the sorting algorithm must perform.

    		0
    SortRangeinteger

    The number of times the data was sorted by using ranges.

    		0
    SortRowsinteger

    The number of sorted rows.

    		0
    SortScaninteger

    The number of sorts that were performed during table scans.

    		1
    NoIndexUsedinteger

    Indicates whether table scans were performed when indexes were not used. Valid values:

    • 1: yes.
    • 0: no.
    		1
    NoGoodIndexUsedinteger

    Indicates whether the server failed to find an index that can be used for the SQL statement. Valid values:

    • 1: yes.
    • 0: no.
    		1
    Dbstring

    The name of the database.

    		testDB

    Examples

    Sample success responses

    JSONformat

    {
  "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 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
    2024-02-27API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400