文档

GetPfsSqlSummaries - 查询按照SQL ID维度统计的全量请求数据

更新时间:

调用GetPfsSqlSummaries接口,查询数据库实例性能洞察(新版)中按照SQL ID维度的全量请求数据。

接口说明

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

  • 使用阿里云或 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:GetPfsSqlSummariesRead
  • 全部资源
    *

请求参数

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

实例 ID。

rm-uf61swc4cru0b****
NodeIdstring

节点 ID。

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

SQL ID。

说明 传入 SQL ID 时,统计目标 SQL ID 的全量请求数据;为空时,统计整个数据库实例的全量请求数据。
651b56fe9418d48edb8fdf0980ec****
Keywordsstring

SQL 文本关键词,多个关键词以空格分隔。

select update
StartTimelong

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

1675833788056
EndTimelong

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

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

排序字段,默认为 count

  • count:执行次数。

  • avgRt:平均执行时间。

  • rtRate:耗时比例。

  • rowsExamined:总扫描行数。

  • avgRowsExamined:平均扫描行数。

  • avgRowsReturned:平均返回行数。

count
Ascboolean

是否升序排序,默认为 false

  • true:是。
  • false:否。
false
PageNointeger

分页查询的页码,从 1 开始,默认为 1。

1
PageSizeinteger

分页查询每页最大记录数,默认为 10,最大为 100。

10

返回参数

名称类型描述示例值
object

ListResult

Messagestring

请求返回消息。

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

请求 ID。

54F3DBAE-9420-511A-9C29-265E8C04****
Dataobject

返回数据。

Totallong

总数据量。

264
Listobject []

详细信息列表。

UserIdstring

用户 ID。

196278346919****
Psqlstring

SQL 模板。

select ?
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****
NodeIdstring

节点 ID。

说明 对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例,返回此参数。
r-x****-db-0
SqlTypestring

SQL 的类型。取值:

  • SELECT
  • UPDATE
  • DELETE
SELECT
LogicIdlong

逻辑库 ID。

58275984
SqlIdstring

SQL 模板 ID。

2e8147b5ca2dfc640dfd5e43d96a****
Timestamplong

数据日期,格式为 Unix 时间戳,单位为毫秒。

1643040000000
RtRatedouble

耗时占比。

0.1384
CountRatedouble

执行次数占比。

0.0586
FullScanboolean

是否全表扫描。取值:

  • true:是。
  • false:否。
true
Countlong

总执行次数。

100000
ErrCountlong

错误次数。

0
WarnCountlong

警告次数。

0
TotalLatencydouble

总执行耗时,单位毫秒。

60913.256
MaxLatencydouble

最大执行耗时,单位毫秒。

36.233
AvgLatencydouble

SQL 平均执行耗时,单位毫秒。

0.1717
RowsSentlong

返回行数。

0
RowsSendAvgdouble

平均发送行数。

0
RowsExaminedlong

总扫描行数。

100
RowsExaminedAvgdouble

平均扫描行数。

0
RowsAffectedlong

影响行数。

0
RowsAffectedAvgdouble

平均影响行数。

0
TmpTableslong

临时表数量。

0
TmpDiskTableslong

临时磁盘表数量。

0
RowsSortedlong

排序行数。

0
SortMergePasseslong

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

0
PhysicalReadslong

物理节点数量。

0
PhysicalAsyncReadslong

物理异步节点数量。

0
SemisyncDelayTimedouble

半同步延迟时间,单位毫秒。

0.12
RowsSentAvgdouble

返回 SQL 句的平均行数。

0.52
LogicReadslong

逻辑节点数。

0
RedoWriteslong

重做节点数。

0
DataWriteTimedouble

数据写入时间,单位毫秒。

0
DataWritesinteger

可写数据节点数量。

0
DataReadTimedouble

可读数据时间,单位毫秒。

0
DataReadsinteger

可读数据节点数量。

0
RwlockOsWaitsinteger

是否开启了读写分离。取值:

  • 0:未开启。
  • 1:开启。
0
RwlockSpinRoundsinteger

读写分离参数。

0
RwlockSpinWaitsinteger

是否开启多重索引扫描。取值:

  • 0:未开启。
  • 1:开启。
0
MutexWaitsinteger

互斥等待次数。

1
MutexSpinsinteger

互斥旋转次数。

1
TransactionLockTimedouble

存储事务锁定时间,单位毫秒。

0
ServerLockTimedouble

服务器锁定时间,单位毫秒。

0
CpuTimedouble

CPU 运行时间,单位为毫秒。

0
ElapsedTimedouble

实际运行时间,单位毫秒。

0
Idlong

主键 ID。

26186357
SelectScanAvgdouble

平均扫描数。

0
SelectRangeAvgdouble

平均选取范围。

0
SelectFullJoinAvgdouble

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

注意 如果该参数值不为 0,则应仔细检查表的索引。

0
SelectFullRangeJoinAvgdouble

平均范围连接数。

0
SortScanAvgdouble

平均扫描排序数。

0
SortRowsAvgdouble

平均排序行数。

0
TmpTablesAvgdouble

临时表平均数。

0
TmpDiskTablesAvgdouble

临时磁盘表平均数。

0
FirstTimelong

首次执行时间,格式为 unix 时间戳,单位为毫秒。

1659308149000
LastTimelong

最后变更时间,格式为 unix 时间戳,单位为毫秒。

1661306520000
LockLatencyAvgdouble

平均锁等待时间,单位毫秒。

0
TimerWaitAvgdouble

备用参数。

None
SortRangeAvgdouble

使用范围排序平均次数。

0
CpuRatedouble

CPU 执行时间与 SQL 总执行时间的比值。

0
Dbstring

数据库名称。

testDB
Tablesarray

数据库表名。

string

数据库表名。

test_table
PageNolong

页码。

1
PageSizelong

每页最大记录数。

10
Extraany

备用参数。

None
Codelong

返回状态码。

200
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "54F3DBAE-9420-511A-9C29-265E8C04****",
  "Data": {
    "Total": 264,
    "List": [
      {
        "UserId": "196278346919****",
        "Psql": "select ?",
        "InstanceId": "rm-2ze8g2am97624****",
        "NodeId": "r-x****-db-0",
        "SqlType": "SELECT",
        "LogicId": 58275984,
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "Timestamp": 1643040000000,
        "RtRate": 0.1384,
        "CountRate": 0.0586,
        "FullScan": true,
        "Count": 100000,
        "ErrCount": 0,
        "WarnCount": 0,
        "TotalLatency": 60913.256,
        "MaxLatency": 36.233,
        "AvgLatency": 0.1717,
        "RowsSent": 0,
        "RowsSendAvg": 0,
        "RowsExamined": 100,
        "RowsExaminedAvg": 0,
        "RowsAffected": 0,
        "RowsAffectedAvg": 0,
        "TmpTables": 0,
        "TmpDiskTables": 0,
        "RowsSorted": 0,
        "SortMergePasses": 0,
        "PhysicalReads": 0,
        "PhysicalAsyncReads": 0,
        "SemisyncDelayTime": 0.12,
        "RowsSentAvg": 0.52,
        "LogicReads": 0,
        "RedoWrites": 0,
        "DataWriteTime": 0,
        "DataWrites": 0,
        "DataReadTime": 0,
        "DataReads": 0,
        "RwlockOsWaits": 0,
        "RwlockSpinRounds": 0,
        "RwlockSpinWaits": 0,
        "MutexWaits": 1,
        "MutexSpins": 1,
        "TransactionLockTime": 0,
        "ServerLockTime": 0,
        "CpuTime": 0,
        "ElapsedTime": 0,
        "Id": 26186357,
        "SelectScanAvg": 0,
        "SelectRangeAvg": 0,
        "SelectFullJoinAvg": 0,
        "SelectFullRangeJoinAvg": 0,
        "SortScanAvg": 0,
        "SortRowsAvg": 0,
        "TmpTablesAvg": 0,
        "TmpDiskTablesAvg": 0,
        "FirstTime": 1659308149000,
        "LastTime": 1661306520000,
        "LockLatencyAvg": 0,
        "TimerWaitAvg": 0,
        "SortRangeAvg": 0,
        "CpuRate": 0,
        "Db": "testDB",
        "Tables": [
          "test_table"
        ]
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None"
  },
  "Code": 200,
  "Success": true
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈