调用GetPfsSqlSample获取SQL样本数据_数据库自治服务(DAS)-阿里云帮助中心

调用GetPfsSqlSample接口，获取性能洞察（新版）功能的SQL样本数据。

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
目标数据库实例为 RDS MySQL 或 PolarDB MySQL 版。
目标数据库实例已开启性能洞察（新版），详情请参见性能洞察（新版）。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。说明仅支持 RDS MySQL 和 PolarDB MySQL 版数据库实例。	rm-2ze1jdv45i7l6****
NodeId	string	否	节点 ID。说明对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例，需要提供节点 ID。	r-x****-db-0
SqlId	string	否	SQL ID。	651b56fe9418d48edb8fdf0980ec****
StartTime	long	是	查询开始时间，格式为 unix 时间戳，单位为毫秒。	1676511134614
EndTime	long	是	查询结束时间，格式为 unix 时间戳，单位为毫秒。说明查询结束时间需晚于查询开始时间，最多可查看最近一个月内任意七天的数据。	1678074351197

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	long	返回状态码。	200
Data	array<object>	返回的 SQL 样本数据。
sample	object	返回数据。
CreateTmpDiskTables	integer	执行语句时创建的磁盘上内部临时表的数量。	0
CreateTmpTables	integer	执行语句时创建的内部临时表的数量。	0
Db	string	数据库名称。	testDB
EndEventId	integer	该参数在事件开始时默认为 NULL，在事件结束时更新为线程当前事件编号。	0
Errors	integer	SQL 语句错误数。	0
EventId	integer	事件 ID。	63735293
EventName	string	事件名称。	statement/sql/select
InstanceId	string	实例 ID。	rm-2ze1jdv45i7l6****
Latency	double	执行耗时，单位为毫秒。	0.199
LockLatency	double	锁等待时间，单位为毫秒。	0.09
LogicId	string	逻辑库 ID。	xxxxx
NoGoodIndexUsed	integer	服务器是否查找不到可用于该语句的索引： 1：是。 0：否。	1
NoIndexUsed	integer	语句在不使用索引的情况下是否执行了表扫描： 1：是。 0：否。	1
NodeId	string	节点 ID。说明 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例才会返回该数据。	r-x****-db-0
RowsAffected	integer	影响行数。	0
RowsExamined	integer	扫描行数。	2048576
RowsSent	integer	返回的 SQL 语句的当前行数。	0
SelectFullJoin	integer	不使用索引而执行表扫描的连接数。注意该参数是用来统计联合查询过程中没有利用索引的情况，如果该参数值不为 0，请仔细检查表的索引。	0
SelectFullRangeJoin	integer	在引用表上使用范围搜索的连接数。	0
SelectRange	integer	在第一个表中使用范围的连接数量。	0
SelectRangeCheck	integer	在每一行数据后对键值进行检查，统计不带键值的连接的数量。注意该参数是用来统计联合查询过程中没有利用索引的情况，如果该参数值不为 0，请仔细检查表的索引。	0
SelectScan	integer	扫描数量。	0
SortMergePasses	integer	排序算法必须执行的合并次数。	0
SortRange	integer	使用范围进行排序的次数。	0
SortRows	integer	排序行数。	0
SortScan	integer	扫描排序次数。	1
Sql	string	SQL 样本。	select * from xxxx where ****
SqlId	string	SQL ID。	651b56fe9418d48edb8fdf0980ec****
ThreadId	integer	线程 ID。	81751940
Timestamp	long	执行 SQL 的时间，格式为 Unix 时间戳，单位为毫秒。	1660100753556
UserId	string	用户 ID。	196278346919****
Warnings	integer	SQL 语句警告数。	0
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	9CB97BC4-6479-55D0-B9D0-EA925AFE****
Success	boolean	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Data": [
    {
      "CreateTmpDiskTables": 0,
      "CreateTmpTables": 0,
      "Db": "testDB",
      "EndEventId": 0,
      "Errors": 0,
      "EventId": 63735293,
      "EventName": "statement/sql/select",
      "InstanceId": "rm-2ze1jdv45i7l6****",
      "Latency": 0.199,
      "LockLatency": 0.09,
      "LogicId": "xxxxx",
      "NoGoodIndexUsed": 1,
      "NoIndexUsed": 1,
      "NodeId": "r-x****-db-0",
      "RowsAffected": 0,
      "RowsExamined": 2048576,
      "RowsSent": 0,
      "SelectFullJoin": 0,
      "SelectFullRangeJoin": 0,
      "SelectRange": 0,
      "SelectRangeCheck": 0,
      "SelectScan": 0,
      "SortMergePasses": 0,
      "SortRange": 0,
      "SortRows": 0,
      "SortScan": 1,
      "Sql": "select * from xxxx where ****",
      "SqlId": "651b56fe9418d48edb8fdf0980ec****",
      "ThreadId": 81751940,
      "Timestamp": 1660100753556,
      "UserId": "196278346919****",
      "Warnings": 0
    }
  ],
  "Message": "Successful",
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-02-27	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情