GetPfsSqlSample - 获取SQL样本数据

调用GetPfsSqlSample接口,获取性能洞察(新版)功能的SQL样本数据。

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetPfsSqlSampleget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

说明 仅支持 RDS MySQL 和 PolarDB MySQL 版数据库实例。
rm-2ze1jdv45i7l6****
NodeIdstring

节点 ID。

说明 对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例,需要提供节点 ID。
r-x****-db-0
SqlIdstring

SQL ID。

651b56fe9418d48edb8fdf0980ec****
StartTimelong

查询开始时间,格式为 unix 时间戳,单位为毫秒。

1676511134614
EndTimelong

查询结束时间,格式为 unix 时间戳,单位为毫秒。

说明 查询结束时间需晚于查询开始时间,最多可查看最近一个月内任意七天的数据。
1678074351197

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

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

返回状态码。

200
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true
Dataarray<object>

返回的 SQL 样本数据。

sampleobject

返回数据。

UserIdstring

用户 ID。

196278346919****
InstanceIdstring

实例 ID。

rm-2ze1jdv45i7l6****
NodeIdstring

节点 ID。

说明 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例才会返回该数据。
r-x****-db-0
LogicIdstring

逻辑库 ID。

xxxxx
Timestamplong

执行 SQL 的时间,格式为 Unix 时间戳,单位为毫秒。

1660100753556
SqlIdstring

SQL ID。

651b56fe9418d48edb8fdf0980ec****
Sqlstring

SQL 样本。

select * from xxxx where ****
ThreadIdinteger

线程 ID。

81751940
EventIdinteger

事件 ID。

63735293
EndEventIdinteger

该参数在事件开始时默认为 NULL,在事件结束时更新为线程当前事件编号。

0
EventNamestring

事件名称。

statement/sql/select
Latencydouble

执行耗时,单位为毫秒。

0.199
LockLatencydouble

锁等待时间,单位为毫秒。

0.09
Errorsinteger

SQL 语句错误数。

0
Warningsinteger

SQL 语句警告数。

0
RowsAffectedinteger

影响行数。

0
RowsSentinteger

返回的 SQL 语句的当前行数。

0
RowsExaminedinteger

扫描行数。

2048576
CreateTmpDiskTablesinteger

执行语句时创建的磁盘上内部临时表的数量。

0
CreateTmpTablesinteger

执行语句时创建的内部临时表的数量。

0
SelectFullJoininteger

不使用索引而执行表扫描的连接数。

注意 该参数是用来统计联合查询过程中没有利用索引的情况,如果该参数值不为 0,请仔细检查表的索引。

0
SelectFullRangeJoininteger

在引用表上使用范围搜索的连接数。

0
SelectRangeinteger

在第一个表中使用范围的连接数量。

0
SelectRangeCheckinteger

在每一行数据后对键值进行检查,统计不带键值的连接的数量。

注意 该参数是用来统计联合查询过程中没有利用索引的情况,如果该参数值不为 0,请仔细检查表的索引。

0
SelectScaninteger

扫描数量。

0
SortMergePassesinteger

排序算法必须执行的合并次数。

0
SortRangeinteger

使用范围进行排序的次数。

0
SortRowsinteger

排序行数。

0
SortScaninteger

扫描排序次数。

1
NoIndexUsedinteger

语句在不使用索引的情况下是否执行了表扫描:

  • 1:是。
  • 0:否。
1
NoGoodIndexUsedinteger

服务器是否查找不到可用于该语句的索引:

  • 1:是。
  • 0:否。
1
Dbstring

数据库名称。

testDB

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

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

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

变更历史

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