DescribeSqlInsightStatistic - 查询SQL洞察统计数据

更新时间:
复制 MD 格式

调用DescribeSqlInsightStatistic接口,按SQL模板、访问来源或数据库用户等维度,聚合统计指定实例在给定时间窗内的SQL洞察数据。

接口说明

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

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 目标实例必须已开启 SQL 洞察功能,未开启时接口返回错误。

调用说明:

  • 本接口为异步接口。首次调用返回 ResultId 与 State,需要携带完全相同的请求参数轮询,直至 State 为 SUCCESS 时才能获取 Data 中的统计结果。

  • StartTime 与 EndTime 均为毫秒级时间戳。StartTime 距当前时间不得超过 30 天,且 StartTime 与 EndTime 的跨度不得超过 7 天。

  • 因数据汇聚存在延迟,EndTime 会被自动裁剪到当前时间前推若干分钟,最近几分钟的数据可能查询不到。

  • StartTime 会被自动收敛到不早于该实例 SQL 洞察功能的开启时间。

返回结果说明:

  • Data.Data.List 为按聚合维度归并后的统计结果,每个元素对应一类 SQL 模板或一个聚合键,而不是单次执行的明细记录。

  • Scnt、AvgScnt、Rows、AvgRows、Frows、AvgFrows 为 PolarDB-X 计算节点专属指标,仅在 Role 为 polarx_cn 时返回。

  • Writes、AvgWrites、MaxWrites、MinWrites、PhysicalRead、AvgPhysicalRead、MaxPhysicalRead、MinPhysicalRead、CpuTime、AvgCpuTime、MaxCpuTime、MinCpuTime 为 SQL Server 实例专属指标。

  • Trend 仅在请求参数 DoFillTrend 为 true 且实例已开启趋势填充能力时返回,时间片间隔由查询跨度自动决定。

  • SqlNew、Params、FirstTime、Extra 等 SQL 样例维度字段不由本接口返回,本接口提供的是模板维度的聚合统计。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:DescribeSqlInsightStatistic

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ConsoleContext

string

否

备用参数。

null

InstanceId

string

是

数据库实例 ID。

说明

支持已开启 SQL 洞察的 RDS MySQL、PolarDB MySQL、PolarDB-X、RDS PostgreSQL、PolarDB PostgreSQL、RDS SQL Server、Lindorm 实例;MongoDB 与 Redis 实例不支持本接口,调用会返回不支持该操作的错误。

rm-bp1q6f9z5xxxxxxxx

NodeId

string

否

实例的节点 ID,用于把统计范围收敛到指定节点。只支持传入单个节点 ID,不支持英文逗号分隔传入多个。

说明

仅在由多个节点组成的实例(例如 PolarDB-X、Lindorm)下需要传入,单节点实例可忽略。

pi-bp1xxxxxxxxxxxx

Type

string

否

统计的聚合维度或过滤维度,取值不区分大小写。不传时默认按 SQL 模板维度聚合。取值:

  • FullRequestOrigin:按访问来源地址维度聚合。

  • FullRequestUser:按数据库用户维度聚合。

  • SQL:按 SQL 模板过滤,需同时传入 TemplateId 作为 SQL 模板 ID。

  • OriginHost:按访问来源过滤,需同时传入 TemplateId 作为来源地址。

  • User:按数据库用户过滤,需同时传入 TemplateId 作为用户名。

说明

传入上述之外的取值返回 InvalidParams 错误。

SQL

TemplateId

string

否

统计对象的标识,含义随 Type 变化。取值:

  • Type 为 SQL 时:传 SQL 模板 ID,即返回结果中的 SqlId。

  • Type 为 OriginHost 时:传访问来源地址。

  • Type 为 User 时:传数据库用户名。

说明

Type 为空、FullRequestOrigin 或 FullRequestUser 时本参数不生效。

说明

Type 为 SQL 时支持英文逗号分隔传入多个模板 ID,且此时 Keyword 不再生效。

9f8e7d6c5b4a3210

Keyword

string

否

按 SQL 模板内容进行模糊检索的关键词,多个关键词以空格分隔。系统先根据关键词匹配出对应的 SQL 模板(最多 1000 个),再基于这些模板聚合统计;若无匹配模板则返回空列表。

说明

当 Type 为 SQL 且已传入 TemplateId 时本参数不生效。

t_order

StartTime

integer

是

查询起始时间,Unix 时间戳,单位毫秒。系统按分钟向下取整。

说明

距今不得超过 30 天;若早于该实例 SQL 洞察的开启时间,会被自动收敛到开启时间。

1718000000000

EndTime

integer

是

查询结束时间,Unix 时间戳,单位毫秒。系统按分钟向上取整。

说明

与 StartTime 的跨度不得超过 7 天。若 EndTime 早于该实例 SQL 洞察的开启时间,会返回查询时间早于可用时间的错误。

说明

由于数据汇聚存在延迟,实际生效值会被裁剪到当前时间前推若干分钟,因此最近几分钟的数据可能查询不到。

1718600000000

OrderBy

string

否

排序字段。不传或传入不支持的取值时按 rt(总耗时)排序。取值:

  • 耗时类:rt、avgRt、maxRt、minRt、rtRate。

  • 执行次数类:count、countRate、timestamp。

  • 扫描行数类:rowsExamined、avgRowsExamined。

  • 返回行数类:rowsReturned、totalRowsReturned、avgRowsReturned、maxRowsReturned、minRowsReturned、maxRowReturned、minRowReturned。

  • 逻辑读类:logicalRead、totalLogicalRead、avgLogicalRead、maxLogicalRead、minLogicalRead。

  • 物理读类:physicalRead、totalPhysicalRead、avgPhysicalRead、maxPhysicalRead、minPhysicalRead。

  • 逻辑写类(仅 SQL Server 实例有效):writes、totalWrites、avgWrites、maxWrites、minWrites。

  • CPU 耗时类(仅 SQL Server 实例有效):totalCpuTime、avgCpuTime、maxCpuTime、minCpuTime。

  • PolarDB-X 计算节点类(仅 Role 为polarx_cn时有效):scnt、avgScnt、rows、avgRows、frows、avgFrows。

  • 影响行数类(仅 Lindorm 实例有效):totalAffectRows、avgAffectRows。

说明

timestamp 表示按数据时间戳排序,该时间戳为毫秒级 Unix 时间戳。

说明

仅首字母大小写不敏感,其余字符需与上述取值完全一致,例如 AvgRt 有效而 avgrt 无效。

rt

Asc

boolean

否

排序方向,默认为 false(降序)。取值:

  • true:升序。

  • false:降序。

false

PageNo

integer

否

分页页码,从 1 开始。不传时按 1 处理。

1

PageSize

integer

否

每页返回的统计条目数。不传时按 10 处理,最大不超过 2000。

说明

超过 2000 会返回参数错误 InvalidParams,而不是被裁剪。

说明

按访问来源或数据库用户维度聚合(Type 为 FullRequestOrigin 或 FullRequestUser)时,部分汇聚存储链路下超过 100 会被重置为 10。

20

DoFillTrend

boolean

否

是否为每条统计结果填充时间序列趋势数据,即返回结果中的 Trend 字段,默认为 true。取值:

  • true:填充趋势数据。

  • false:不填充趋势数据。

说明

开启后会针对每条结果额外查询各时间片的数据,查询开销明显增加;若实例未开启趋势填充能力,本参数不生效。

true

SqlType

string

否

按 SQL 类型过滤。取值:

  • select

  • insert

  • update

  • delete

说明

取值为小写。部分实例的汇聚存储链路下支持英文逗号分隔传入多个取值,其余链路只支持传入单个取值。

select

DbName

string

否

按数据库名过滤。

说明

部分实例的汇聚存储链路下支持英文逗号分隔传入多个,其余链路只支持传入单个数据库名。

db_test

Role

string

否

实例节点角色,取值不区分大小写。不传时由 InstanceId 自动解析。取值:

  • polarx_cn:PolarDB-X 计算节点。

  • polarx_dn:PolarDB-X 存储节点。

说明

该取值会影响返回字段的填充范围,例如 Scnt、Rows、Frows 仅在polarx_cn下返回。

polarx_cn

JobId

string

否

SQL 洞察数据查询幂等 ID,普通查询无需传入。

9a4f5c4494dbd6713185d87a97aa53e8

Filters

array<object>

否

结构化过滤条件列表,以 Key/Value 键值对形式传入,POP 线格式为Filters.N.Key与Filters.N.Value,最多 100 组。Key 不区分大小写,Value 为空的条目会被忽略。本接口生效的 Key 取值:

  • keyWord:关键词,按空白字符拆分为多个词,与 Keyword 参数合并生效。

  • hostAddress:访问来源地址,英文逗号分隔多个,与 Type 为 OriginHost 时的 TemplateId 合并生效。

  • accountName:数据库用户名,英文逗号分隔多个。

  • dbName:数据库名,英文逗号分隔多个,与 DbName 参数合并生效。

  • sqlType:SQL 类型,英文逗号分隔多个,与 SqlType 参数合并生效。

  • sqlId:SQL 模板 ID,英文逗号分隔多个,与 Type 为 SQL 时的 TemplateId 合并生效。

  • insRole:主备角色,取值 master 或 slave,该取值区分大小写。

说明

传入上述之外的 Key 会被忽略。

说明

本参数仅在部分实例的汇聚存储链路下生效,其余链路会整体忽略该参数。

object

否

Key

string

否

过滤条件的键,不区分大小写。可用取值见 Filters 参数说明。

sqlType

Value

string

否

过滤条件的值,为 null 或空字符串时该条过滤条件被忽略。多个值以英文逗号分隔,具体上限取决于对应的键。

select

返回参数

名称

类型

描述

示例值

object

Code

string

响应状态码。

200

Data

object

异步查询结果信封。首次调用返回 ResultId 与 State,需携带完全相同的请求参数轮询,直到 State 为 SUCCESS 后从 List 中获取统计明细。

Data

object

SQL 洞察统计查询结果。

说明

仅当 State 为 SUCCESS 时返回。

Extra

any

扩展信息。

说明

本接口不返回该字段。

{}

List

array<object>

SQL 洞察统计结果列表,每个元素为一个聚合维度下的统计条目。

array<object>

AffectRows

integer

单条 SQL 的影响行数。SELECT 表示扫描行数,DML 表示影响行数。

说明

仅 Lindorm 实例返回。

30

AggKey

string

本次统计的聚合维度取值,随请求参数 Type 变化。取值:

  • 按 SQL 模板聚合时:SQL 模板 ID,与 SqlId 一致。

  • Type 为 FullRequestOrigin 时:访问来源地址。

  • Type 为 FullRequestUser 时:数据库用户名。

651b56fe9418d48edb8fdf0980ec****

AvgAffectRows

number

平均影响行数。

说明

仅 Lindorm 实例返回,其它引擎为 null。

30.2

AvgCpuTime

number

SQL 执行消耗的平均 CPU 耗时,单位微秒。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

12.5

AvgFrows

number

PolarDB-X 计算节点从数据节点拉取的平均行数。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

AvgLockWaitTime

number

单次执行的平均锁等待耗时,单位毫秒。

说明

仅在 Version 为 1 时有数据。

0.00009589874265269765

AvgLogicalRead

number

单次执行的平均逻辑读次数。

说明

仅在 Version 为 1 时有数据。

654.4470327860251

AvgPhysicalAsyncRead

number

单次执行的平均物理异步读次数。

说明

仅在 Version 为 1 时有数据。

0

AvgPhysicalRead

number

平均物理读次数。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

654.4

AvgPhysicalSyncRead

number

单次执行的平均物理同步读次数。

说明

仅在 Version 为 1 时有数据。

0

AvgRows

number

PolarDB-X 计算节点的平均更新行数与返回行数。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

AvgRowsExamined

number

单次执行的平均扫描行数。

53421.0

AvgRowsReturned

number

单次执行的平均返回行数。

14

AvgRowsUpdated

number

单次执行的平均更新行数。

30.2

AvgRt

number

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

2.499

AvgScanRows

number

平均扫描行数。

说明

本接口不返回该字段,平均扫描行数请使用 AvgRowsExamined。

53421.0

AvgScnt

number

PolarDB-X 计算节点下发到数据节点的平均请求数。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

AvgWrites

number

平均逻辑写次数。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

10

Count

integer

该 SQL 模板在统计区间内的执行总次数。

127

CountRate

number

该条统计的执行次数占实例全部 SQL 执行次数的比例,取值范围为 0 到 1。

0.0586

CpuTime

integer

SQL 执行消耗的 CPU 耗时合计,单位微秒。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

100

Database

string

该 SQL 执行所在的数据库名。

dbtest01

ErrorCode

string

SQL 执行返回的错误码。

说明

错误码属于单条 SQL 明细信息,本接口返回的是模板维度的聚合统计,不返回该字段;报错情况请使用 ErrorCount。

1146

ErrorCount

integer

该 SQL 模板在统计区间内执行报错的次数。

1

FirstTime

integer

SQL 模板首次出现的时间,格式为 Unix 时间戳,单位为毫秒(ms)。

说明

本接口不返回该字段。

1659308149000

Frows

integer

PolarDB-X 计算节点从数据节点拉取的行数合计。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

Hash

string

SQL 模板哈希值,随 SQL 模板一并返回。

说明

该值由 PolarDB-X 计算节点内核输出,非 PolarDB-X 计算节点实例为空。

2e8147b5ca2dfc640dfd5e43d96a****

Ip

string

统计数据所属实例的连接地址。

说明

是否返回取决于实例的汇聚存储链路,部分链路下为 null。

rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com

LockWaitTime

number

锁等待耗时合计,单位毫秒。

说明

仅在 Version 为 1 时有数据。

1089.4177720290281

LogicalRead

number

逻辑读次数合计。

说明

仅在 Version 为 1 时有数据。

165848

MaxCpuTime

integer

单次执行中 CPU 耗时的最大值,单位微秒。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

30

MaxLogicalRead

integer

单次执行中逻辑读次数的最大值。

说明

仅在 Version 为 1 时有数据。

3186

MaxPhysicalRead

integer

单次执行中物理读次数的最大值。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

3186

MaxRowsExamined

integer

单次执行中扫描行数的最大值。

说明

本接口不返回该字段,扫描行数请使用 RowsExamined 与 AvgRowsExamined。

318613

MaxRowsReturned

integer

单次执行中返回行数的最大值。

20

MaxRt

number

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

12.499

MaxWrites

integer

单次执行中逻辑写次数的最大值。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

12

MinCpuTime

integer

单次执行中 CPU 耗时的最小值,单位微秒。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

5

MinLogicalRead

integer

单次执行中逻辑读次数的最小值。

说明

仅在 Version 为 1 时有数据。

12

MinPhysicalRead

integer

单次执行中物理读次数的最小值。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

12

MinRowsReturned

integer

单次执行中返回行数的最小值。

1

MinRt

number

单次执行的最小耗时,单位毫秒。

0.409789

MinWrites

integer

单次执行中逻辑写次数的最小值。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

8

OriginAlias

string

为访问来源地址配置的展示别名。

说明

仅在按访问来源聚合(Type 为 FullRequestOrigin)时返回,其它场景为 null。

order-1

OriginHost

string

发起该 SQL 的客户端来源地址。

说明

当 Type 为 FullRequestOrigin 时,该字段即为这条统计的聚合维度。

172.26.XX.XXX

Params

string

SQL 样例的参数内容。

说明

本接口返回的是模板维度的聚合统计,不返回该字段。

[1, "das"]

PhysicalAsyncRead

number

物理异步读次数合计。

说明

仅在 Version 为 1 时有数据。

0

PhysicalRead

integer

物理读次数合计。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

165848

PhysicalSyncRead

number

物理同步读次数合计。

说明

仅在 Version 为 1 时有数据。

0

Port

integer

统计数据所属实例的连接端口。

说明

是否返回取决于实例的汇聚存储链路,部分链路下为 null。

3306

Psql

string

参数化后的 SQL 模板文本,即把 SQL 中的常量替换为占位符后的语句。

select * from t_order where id = ?

Rows

integer

PolarDB-X 计算节点的更新行数与返回行数合计。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

RowsExamined

integer

该 SQL 模板在统计区间内的扫描行数合计。

2048576

RowsReturned

integer

该 SQL 模板在统计区间内的返回行数合计。

14

Rt

number

该 SQL 模板在统计区间内的总耗时,单位毫秒。

说明

PolarDB-X 计算节点(Role 为polarx_cn)在内核版本早于 5.4.13 时,该值由微秒换算为毫秒。

0.409789

RtGreaterThanOneSecondCount

integer

执行耗时超过 1 秒的次数。

说明

是否返回取决于实例的汇聚存储链路,部分链路下为 null。

20

RtRate

number

该条统计的总耗时占实例全部 SQL 总耗时的比例,取值范围为 0 到 1。

0.1384

SampleType

string

样本数据的类型标识。

说明

本接口返回的是聚合统计,不返回该字段。

sql

ScanRows

integer

单条 SQL 的扫描行数。

说明

本接口返回的是模板维度的聚合统计,不返回该字段,请使用聚合指标 RowsExamined 与 AvgRowsExamined。

29

Scnt

integer

PolarDB-X 计算节点下发到数据节点的请求总数。

说明

为 PolarDB-X 计算节点专属指标,其它引擎为 null 或 0。

10

Sql

string

原始 SQL 文本。

说明

统计结果返回的是 SQL 模板(Psql),不返回该字段。

select * from t_order where id = 1

SqlId

string

SQL 模板 ID,唯一标识一类参数化后的 SQL 语句。同一模板下的多次执行会被聚合为一条统计,可用该 ID 在多维度查询间关联同一类 SQL。

651b56fe9418d48edb8fdf0980ec****

SqlNew

string

对参数值做统一处理后的 SQL 文本,用于样本数据场景。

说明

本接口不返回该字段。

select * from t_order where id = ?

SqlTextFeature

string

SQL 文本特征值,用于 SQL 分析场景。

说明

本接口不返回该字段。

select_from_t_order

SqlType

string

SQL 类型。取值:

  • select

  • insert

  • update

  • delete

  • other

select

SumRowsUpdated

number

该 SQL 模板在统计区间内的更新行数合计。

3810

Tables

array

该 SQL 涉及的表名列表。

string

该 SQL 涉及的表名。

t_order

ThreadId

string

执行该 SQL 的数据库线程 ID。

说明

线程 ID 属于单条 SQL 明细信息,本接口返回的是模板维度的聚合统计,不返回该字段。

57472578

TimeRate

number

耗时占比。

说明

本接口通过 RtRate 返回耗时占比,不返回该字段。

0.1384

Timestamp

integer

数据时间戳,Unix 时间戳,单位毫秒。

说明

统计结果按 SQL 模板维度汇总,不返回该字段。

1718600000000

TotalAffectRows

integer

影响行数合计。

说明

仅 Lindorm 实例返回,其它引擎为 null。

3810

TotalRt

integer

SQL 执行总耗时。

说明

本接口不返回该字段,总耗时请使用 Rt。

310

TotalScanRows

integer

扫描行数合计。

说明

本接口不返回该字段,扫描行数合计请使用 RowsExamined。

2048576

Trend

array<object>

该 SQL 模板在查询时间窗内按时间片划分的执行次数趋势序列。

说明

仅当请求参数 DoFillTrend 为 true 且实例已开启趋势填充能力时返回;时间片间隔由查询跨度自动决定,无数据的时间片可能补零。

object

Timestamp

integer

趋势点的时间戳,Unix 时间戳,单位毫秒。

1718000000000

Value

any

该时间片内的 SQL 执行次数。

12

UpdateRows

integer

单条 SQL 的更新行数。

说明

本接口返回的是模板维度的聚合统计,不返回该字段,请使用聚合指标 SumRowsUpdated 与 AvgRowsUpdated。

30

User

string

执行该 SQL 的数据库用户名。

说明

当 Type 为 FullRequestUser 时,该字段即为这条统计的聚合维度。

testUser

Version

integer

SQL 洞察数据采集链路版本。实例采集到逻辑读或锁等待数据时返回 1,否则返回 0。取值:

  • 0:V0 基础采集链路。

  • 1:V1 采集链路,在 V0 基础上额外采集 LockWaitTime、LogicalRead、PhysicalSyncRead、PhysicalAsyncRead 四类指标。

说明

返回 0 时上述扩展指标无数据。

1

VpcId

string

统计数据所属实例的专有网络 VPC ID。

说明

是否返回取决于实例的汇聚存储链路,部分链路下为 null。

vpc-2zentqj1sk4qmolci****

Writes

integer

逻辑写次数合计。

说明

为 SQL Server 实例专属指标,其它引擎为 null。

10

PageNo

integer

当前页码,与请求参数 PageNo 对应。

1

PageSize

integer

每页返回的条数,与请求参数 PageSize 对应。

10

Total

integer

满足查询条件的统计条目总数,可用于分页计算。

10

ErrorCode

integer

异步查询失败的错误码。

说明

仅在查询失败时返回。

-10200020

IsFinish

boolean

异步查询是否已结束。取值:

  • true:State 为 SUCCESS 或 FAIL。

  • false:State 为 RUNNING。

Message

string

异步查询失败的错误描述。

说明

仅在查询失败时返回。

startTime must be in 30 days and the interval must be within 7 day

RequestKey

string

请求参数的哈希标识。

说明

本接口不返回该字段,请使用 ResultId 标识异步查询。

507044db6c4eadfa2dab9b084e80****

ResultId

string

异步查询结果 ID,形如 async_前缀加一串哈希值,由本次请求的全部业务参数计算得出。

说明

相同参数重复调用会命中同一份查询结果,因此轮询时必须携带与首次调用完全相同的请求参数;任一参数变化都会生成不同的 ResultId 并触发一次全新的查询。

async__507044db6c4eadfa2dab9b084e80****

State

string

异步查询的当前状态。取值:

  • RUNNING:执行中,需继续轮询。

  • SUCCESS:执行成功,此时 Data 才有值。

  • FAIL:执行失败。

说明

查询失败时接口会直接返回错误码与错误信息,而非 State 为 FAIL 的正常响应体。

SUCCESS

Timestamp

integer

提交本次异步查询的时间,Unix 时间戳,单位毫秒。

说明

查询失败时该值为失败发生的时间。

1718600000000

Message

string

响应信息。请求失败时返回错误描述。

Successful

RequestId

string

本次请求的唯一标识,可用于问题排查。

B6D17591-B48B-4D31-9CD6-9B9796B2****

Success

string

本次请求是否成功。取值:

  • true:成功。

  • false:失败,此时结合 Code 与 Message 判断原因。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "Data": {
      "Extra": "{}",
      "List": [
        {
          "AffectRows": 30,
          "AggKey": "651b56fe9418d48edb8fdf0980ec****",
          "AvgAffectRows": 30.2,
          "AvgCpuTime": 12.5,
          "AvgFrows": 10,
          "AvgLockWaitTime": 0.00009589874265269765,
          "AvgLogicalRead": 654.4470327860251,
          "AvgPhysicalAsyncRead": 0,
          "AvgPhysicalRead": 654.4,
          "AvgPhysicalSyncRead": 0,
          "AvgRows": 10,
          "AvgRowsExamined": 53421,
          "AvgRowsReturned": 14,
          "AvgRowsUpdated": 30.2,
          "AvgRt": 2.499,
          "AvgScanRows": 53421,
          "AvgScnt": 10,
          "AvgWrites": 10,
          "Count": 127,
          "CountRate": 0.0586,
          "CpuTime": 100,
          "Database": "dbtest01",
          "ErrorCode": "1146",
          "ErrorCount": 1,
          "FirstTime": 1659308149000,
          "Frows": 10,
          "Hash": "2e8147b5ca2dfc640dfd5e43d96a****",
          "Ip": "rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com",
          "LockWaitTime": 1089.4177720290281,
          "LogicalRead": 165848,
          "MaxCpuTime": 30,
          "MaxLogicalRead": 3186,
          "MaxPhysicalRead": 3186,
          "MaxRowsExamined": 318613,
          "MaxRowsReturned": 20,
          "MaxRt": 12.499,
          "MaxWrites": 12,
          "MinCpuTime": 5,
          "MinLogicalRead": 12,
          "MinPhysicalRead": 12,
          "MinRowsReturned": 1,
          "MinRt": 0.409789,
          "MinWrites": 8,
          "OriginAlias": "order-1",
          "OriginHost": "172.26.XX.XXX",
          "Params": "[1, \"das\"]",
          "PhysicalAsyncRead": 0,
          "PhysicalRead": 165848,
          "PhysicalSyncRead": 0,
          "Port": 3306,
          "Psql": "select * from t_order where id = ?",
          "Rows": 10,
          "RowsExamined": 2048576,
          "RowsReturned": 14,
          "Rt": 0.409789,
          "RtGreaterThanOneSecondCount": 20,
          "RtRate": 0.1384,
          "SampleType": "sql",
          "ScanRows": 29,
          "Scnt": 10,
          "Sql": "select * from t_order where id = 1",
          "SqlId": "651b56fe9418d48edb8fdf0980ec****",
          "SqlNew": "select * from t_order where id = ?",
          "SqlTextFeature": "select_from_t_order",
          "SqlType": "select",
          "SumRowsUpdated": 3810,
          "Tables": [
            "t_order"
          ],
          "ThreadId": "57472578",
          "TimeRate": 0.1384,
          "Timestamp": 1718600000000,
          "TotalAffectRows": 3810,
          "TotalRt": 310,
          "TotalScanRows": 2048576,
          "Trend": [
            {
              "Timestamp": 1718000000000,
              "Value": "12"
            }
          ],
          "UpdateRows": 30,
          "User": "testUser",
          "Version": 1,
          "VpcId": "vpc-2zentqj1sk4qmolci****",
          "Writes": 10
        }
      ],
      "PageNo": 1,
      "PageSize": 10,
      "Total": 10
    },
    "ErrorCode": -10200020,
    "IsFinish": true,
    "Message": "startTime must be in 30 days and the interval must be within 7 day",
    "RequestKey": "507044db6c4eadfa2dab9b084e80****",
    "ResultId": "async__507044db6c4eadfa2dab9b084e80****",
    "State": "SUCCESS",
    "Timestamp": 1718600000000
  },
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

错误码

HTTP status code

错误码

错误信息

描述

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

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

变更历史

更多信息,参考变更详情。