调用GetPfsSqlSummaries查询按照SQLID维度统计的全量请求数据

调用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:GetPfsSqlSummaries	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例 ID。	rm-uf61swc4cru0b****
NodeId	string	否	节点 ID。说明对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例，需要提供节点 ID。	r-****-db-0
SqlId	string	否	SQL ID。说明传入 SQL ID 时，统计目标 SQL ID 的全量请求数据；为空时，统计整个数据库实例的全量请求数据。	651b56fe9418d48edb8fdf0980ec****
Keywords	string	否	SQL 文本关键词，多个关键词以空格分隔。	select update
StartTime	long	否	查询开始时间，格式为 Unix 时间戳，单位为毫秒。	1675833788056
EndTime	long	否	查询结束时间，格式为 Unix 时间戳，单位为毫秒。说明查询结束时间需晚于查询开始时间，最多可查看最近一个月内任意七天的数据。	1679297005999
OrderBy	string	否	排序字段，默认为 count。 count：执行次数。 avgRt：平均执行时间。 rtRate：耗时比例。 rowsExamined：总扫描行数。 avgRowsExamined：平均扫描行数。 avgRowsReturned：平均返回行数。	count
Asc	boolean	否	是否升序排序，默认为 false。 true：是。 false：否。	false
PageNo	integer	否	分页查询的页码，从 1 开始，默认为 1。	1
PageSize	integer	否	分页查询每页最大记录数，默认为 10，最大为 100。	10

返回参数

名称	类型	描述	示例值
	object	ListResult
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	54F3DBAE-9420-511A-9C29-265E8C04****
Data	object	返回数据。
Total	long	总数据量。	264
List	array<object>	详细信息列表。
List	object	返回信息列表。
UserId	string	用户 ID。	196278346919****
Psql	string	SQL 模板。	select ?
InstanceId	string	实例 ID。	rm-2ze8g2am97624****
NodeId	string	节点 ID。说明对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例，返回此参数。	r-x****-db-0
SqlType	string	SQL 的类型。取值： SELECT UPDATE DELETE	SELECT
LogicId	long	逻辑库 ID。	58275984
SqlId	string	SQL 模板 ID。	2e8147b5ca2dfc640dfd5e43d96a****
Timestamp	long	数据日期，格式为 Unix 时间戳，单位为毫秒。	1643040000000
RtRate	double	耗时占比。	0.1384
CountRate	double	执行次数占比。	0.0586
FullScan	boolean	是否全表扫描。取值： true：是。 false：否。	true
Count	long	总执行次数。	100000
ErrCount	long	错误次数。	0
WarnCount	long	警告次数。	0
TotalLatency	double	总执行耗时，单位毫秒。	60913.256
MaxLatency	double	最大执行耗时，单位毫秒。	36.233
AvgLatency	double	SQL 平均执行耗时，单位毫秒。	0.1717
RowsSent	long	返回行数。	0
RowsSendAvg	double	平均发送行数。	0
RowsExamined	long	总扫描行数。	100
RowsExaminedAvg	double	平均扫描行数。	0
RowsAffected	long	影响行数。	0
RowsAffectedAvg	double	平均影响行数。	0
TmpTables	long	临时表数量。	0
TmpDiskTables	long	临时磁盘表数量。	0
RowsSorted	long	排序行数。	0
SortMergePasses	long	排序算法必须执行的合并次数。	0
PhysicalReads	long	物理节点数量。	0
PhysicalAsyncReads	long	物理异步节点数量。	0
SemisyncDelayTime	double	半同步延迟时间，单位毫秒。	0.12
RowsSentAvg	double	返回 SQL 句的平均行数。	0.52
LogicReads	long	逻辑节点数。	0
RedoWrites	long	重做节点数。	0
DataWriteTime	double	数据写入时间，单位毫秒。	0
DataWrites	integer	可写数据节点数量。	0
DataReadTime	double	可读数据时间，单位毫秒。	0
DataReads	integer	可读数据节点数量。	0
RwlockOsWaits	integer	是否开启了读写分离。取值： 0：未开启。 1：开启。	0
RwlockSpinRounds	integer	读写分离参数。	0
RwlockSpinWaits	integer	是否开启多重索引扫描。取值： 0：未开启。 1：开启。	0
MutexWaits	integer	互斥等待次数。	1
MutexSpins	integer	互斥旋转次数。	1
TransactionLockTime	double	存储事务锁定时间，单位毫秒。	0
ServerLockTime	double	服务器锁定时间，单位毫秒。	0
CpuTime	double	CPU 运行时间，单位为毫秒。	0
ElapsedTime	double	实际运行时间，单位毫秒。	0
Id	long	主键 ID。	26186357
SelectScanAvg	double	平均扫描数。	0
SelectRangeAvg	double	平均选取范围。	0
SelectFullJoinAvg	double	不使用索引而执行表扫描的平均连接数。注意如果该参数值不为 0，则应仔细检查表的索引。	0
SelectFullRangeJoinAvg	double	平均范围连接数。	0
SortScanAvg	double	平均扫描排序数。	0
SortRowsAvg	double	平均排序行数。	0
TmpTablesAvg	double	临时表平均数。	0
TmpDiskTablesAvg	double	临时磁盘表平均数。	0
FirstTime	long	首次执行时间，格式为 unix 时间戳，单位为毫秒。	1659308149000
LastTime	long	最后变更时间，格式为 unix 时间戳，单位为毫秒。	1661306520000
LockLatencyAvg	double	平均锁等待时间，单位毫秒。	0
TimerWaitAvg	double	备用参数。	None
SortRangeAvg	double	使用范围排序平均次数。	0
CpuRate	double	CPU 执行时间与 SQL 总执行时间的比值。	0
Db	string	数据库名称。	testDB
Tables	array	数据库表名。
	string	数据库表名。	test_table
PageNo	long	页码。	1
PageSize	long	每页最大记录数。	10
Extra	any	备用参数。	None
Code	long	返回状态码。	200
Success	boolean	请求是否执行成功： 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	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史