DescribeSlowLogStatistic - 慢日志统计信息

慢日志统计信息。

接口说明

请确保在使用该接口前,已充分了解 DAS 产品的收费方式和价格

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

  • 请求实例已开通DAS 企业版,或者智能运维服务(暂未上线)。
  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

该接口异步调用后不会立即返回完整结果,当返回数据中 isFinish 取值为 false 时,请等待 1s 后重新发起调用,直到 isFinish 取值为 true 时,返回完整结果。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

rm-2ze1jdv45i7l6****
NodeIdstring

节点 ID。

  • 对于 RDS MySQL 和 PolarDB MySQL 版,该参数仅适用于集群版实例。若不传该参数,默认查询主节点日志明细。
  • 对于 PolarDB-X 2.0,该参数传入polarx_cn(计算节点)或polarx_dn(数据节点)。
r-x****-db-0
Typestring

任务类型:

SlowLogRequestOrigin:groupBy originHost,通过来源 IP 聚合模板。

OriginHost:OriginHost groupBy SQLID,通过 SQLID 聚合模板,并且限制 originHost 为 templateID。

SlowLogRequestUser:groupBy user,通过来源 USER 聚合模板。

SQL:SQL groupBy SQLID,通过 SQLID 聚合模板,并且限制 SQLID 为 templateID。

SQL
TemplateIdstring

模板 ID。

04ea3310df40c3fa8a6b4854db49f79a
StartTimelong

查询任务开始时间,格式为 Unix 时间戳(UTC 时间),单位为毫秒。

1568269711000
EndTimelong

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

1608888296000
OrderBystring

排序方式,可选为:

Count

QueryTime

LockTime

RowsExamined

RowsSent

count
Ascboolean

升序排序开关,默认关闭。

true
PageNumberinteger

查询列表的页码,起始值为 1,默认值为 1。

1
PageSizeinteger

每页最大记录数,默认值为 10。

20
Filtersarray<object>

查询筛选条件列表。

Itemobject

Key 支持的参数和取值:

hostAddress:来源,多个逗号分隔。

sqlId:sqlId,多个逗号分隔。

user:用户,多个逗号分隔。

dbName:数据库,多个逗号分隔。

keyWord:关键字,多个空格分隔。

tags:标签,多个逗号分隔。

Keystring

过滤参数

KeyWords
Valuestring

过滤参数的值。

select

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

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

请求 ID。

52D540CF-C517-1F57-BB42-9035F96******
Successstring

请求是否执行成功:

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

AsyncResult<DBLogRecords>

RequestKeystring

请求参数的 Key。

123456789
ResultIdstring

结果 ID。

async__665ee69612f1627c7fd9f3c85075****
Statestring

当前状态:

-RUNNING:正在运行。

-SUCCESS:成功。

-FAIL:失败。

SUCCESS
IsFinishboolean

是否完成。

true
Dataobject

数据。

DbInstanceNamestring

实例 ID。

0
NodeIdstring

节点 ID。

对于 MongoDB 实例,通过该参数指定节点进行空间分析。调用 DescribeRoleZoneInfo 接口,可以查询 MongoDB 实例各个节点的详细信息。

  • 当传入目标节点的 InsName(节点 ID)时,例如d-bp1872fa24d5****,调用该接口分析其对应的 Hidden 节点。
  • 当传入目标节点的InsName#RoleId时,例如d-bp1872fa24d5****#299****5,调用该接口分析指定的节点。

注意 对于 MongoDB 副本集实例,不传入此参数时,调用该接口会默认分析唯一的 Hidden 节点。对于 MongoDB 分片集群实例,推荐传入此参数,指定目标节点。

pi-wz99g5rn7w1x8h0sf
ItemsNumberslong

当前页查询日志列表内的 Item 数量。

10
StartTimestring

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

2024-10-08T02:01:00Z
EndTimestring

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

说明 查询任务结束时间需晚于查询任务开始时间。
2024-08-08T02:15:00Z
DbInstanceIdlong

实例数字 ID。

rm-k2ja51w7cnusg5a1x
TotalRecordslong

总记录数。

13
PageNumbersinteger

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

1
MaxRecordsPerPageinteger

分页查询每页最大记录数。取值范围:5~100。

10
Logsarray<object>

操作对象名称。

Logobject

日志。

Countlong

Key 的元素个数。

12
MaxLockTimedouble

已废弃。

-
MaxQueryTimedouble

已废弃。

-
MaxRowsExaminedlong

最大扫描行数。

318613
MaxRowsSentlong

最大返回行数。

256
AvgQueryTimedouble

已废弃。

-
QueryTimeRatedouble

查询耗时比例。

0.1018
CountRatedouble

执行次数比例。

0.2034
AvgRowsExamineddouble

平均扫描行数。

53421.0
OriginAliasstring

来源别名。

order-1
Userstring

用户。

user-1
SqlTagobject

标签。

SqlIdstring

SQL ID。

a3931d8c3a9315dd5ed016d71cf*****
Tagsstring

逗号分隔的多个 tag。

DAS_IN_PLAN
Commentsstring

备注。

长度为 1~300 个字符。

dba 归档
Trendarray<object>

慢日志趋势。

Trendobject

慢日志趋势。

Timestamplong

执行时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1723775362
Valueany

过滤参数的值。

tf-testacc-oos-parameter
Databasestring

数据库名。

work-wechat-api
Histogramobject

趋势图数据。

Totallong

查询的总记录数。

7
Countarray

慢日志数量。

Countlong

慢日志数量。

100
Tsarray

执行时间戳。

Tlong

事件发生的时间,使用 UNIX 时间戳表示,单位:秒。

1715220818
TsEndarray

已废弃。

TsEndlong

已废弃。

-
Itemarray<object>

任务状态。

Itemobject

错误码信息。

NodeIdstring

节点 id。

r-bp1s1m8hwzrm77kfvz-db-0
Countarray

慢日志数量。

Countlong

Key 的元素个数。

100
Rtarray

执行耗时,单位为秒。

Rtdouble

执行耗时,单位为秒。

1854
AvgRtarray

平均执行耗时。

AvgRtdouble

平均执行耗时。

3709
MaxRtarray

最大 RT,单位 ms。

MaxRtdouble

最大 RT,单位 ms。

2516.0
LockTimearray

锁等待时间,单位毫秒。

LockTimedouble

锁等待时间,单位毫秒。

300
AvgLockTimearray

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

AvgLockTimedouble

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

15
MaxLockTimearray

最大锁等待时间,单位为秒。

MaxLockTimedouble

最大锁等待时间,单位为秒。

1051
RowsExaminedarray

总扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
RowsExaminedlong

总扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
641057
AvgRowsExaminedarray

平均扫描行数。

AvgRowsExamineddouble

平均扫描行数。

222189
MaxRowsExaminedarray

最大扫描行数。

MaxRowsExaminedlong

最大扫描行数。

878511
RowsSentarray

返回行数。

RowsSentlong

返回行数。

4
AvgRowsSentarray

平均返回行数。

AvgRowsSentdouble

平均返回行数。

2.0
MaxRowsSentarray

最大返回行数。

MaxRowsSentlong

最大返回行数。

256
SqlIdstring

SQL ID。

2dca88762ec6b3812504ab8a4b******
Schemestring

HTTP 或 HTTPS。

HTTP
SubInstanceIdstring

子实例 ID。

r-8vba51c588ba3a94
DbInstanceNamestring

实例 ID。

0
InsNamestring

分片名。

rm-uf6zix1z2jh1y6fe5
AccountNamestring

数据库账号。

edu_admin
HostAddressstring

客户端 IP 地址。

172.23.142.178
QueryStartTimestring

查询开始的时间。格式:yyyy-MM-dd hh:mm:ss(UTC 时间)。

2024-12-25T03:00:00Z
SQLTextstring

SQL 语句详情。

SELECT 'Hello, World!' FROM DUAL
Psqlstring

SQL 模板。

SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.id DESC
DBNamestring

数据库名称。

member_score
QueryTimelong

查询执行时间阈值,单位为毫秒(ms)。

272.444
ReturnItemNumbersstring

返回项目编号。

暂无
DocsExaminedlong

MongoDB 该操作执行时扫描的文档数。

1
KeysExaminedlong

MongoDB 索引扫描行数。

20000
TableNamestring

表名。

users\nifconfig\n
LockTimedouble

已废弃。

-
RowsExaminedlong

总扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
2444081
RowsSentlong

返回行数。

772
ThreadIdstring

仅 PolarDB MySQL 有 thread_id。

1
Timestamplong

执行时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1708568930
AvgLockTimedouble

已废弃。

-
AvgRowsSentdouble

平均返回行数。

2.0
LockTimeSecondsdouble

锁等待时间,单位为秒。

0.0
QueryTimeSecondsdouble

查询耗时,单位为秒。

25.472
AvgLockTimeSecondsdouble

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

0.0
MaxLockTimeSecondsdouble

最大锁等待时间,单位为秒。

0.0
MaxQueryTimeSecondsdouble

最大查询耗时,单位为秒。

14.402
AvgQueryTimeSecondsdouble

平均查询耗时,单位为秒。

6.211
SqlTypestring

SQL 语句的类型。

LOGIN
QueryIdstring

Query ID。

说明 仅云数据库 MongoDB 版实例支持。
sq-1pzcdMwRb
NodeTypestring

节点类型。

说明 目前支持该字段的数据库:云数据库 MongoDB 版、云数据库 Tair(兼容 Redis)。
DLNode
HostInsIdstring

主机实例 id。

说明 仅云数据库 MongoDB 版实例支持。
mongo-abc123456
InsRolestring

实例角色。

说明 仅云数据库 MongoDB 版实例支持。
__system
OpTypestring

操作类型。

说明 仅云数据库 MongoDB 版实例支持。
Insert
Namespacestring

命名空间。

说明 仅云数据库 MongoDB 版实例支持。
database.collection
AvgKeysExamineddouble

平均索引扫描行数。

说明 仅云数据库 MongoDB 版实例支持。
20000
AvgDocExamineddouble

平均扫描文档行数。

说明 仅云数据库 MongoDB 版实例支持。
10000
AvgReturnNumdouble

平均返回行数。

说明 仅云数据库 MongoDB 版实例支持。
1
MaxKeysExaminedlong

最大索引扫描行数。

说明 仅云数据库 MongoDB 版实例支持。
2000000
MaxDocExaminedlong

最大扫描文档行数。

说明 仅云数据库 MongoDB 版实例支持。
1000000
MaxReturnNumlong

最大返回行数。

说明 仅云数据库 MongoDB 版实例支持。
1
ReturnNumlong

返回行数。

说明 仅云数据库 MongoDB 版实例支持。
1
DocExaminedlong

扫描文档行数。

说明 仅云数据库 MongoDB 版实例支持。
2000000
Commandstring

慢查询语句。

说明 仅云数据库 Tair(兼容 Redis)实例支持。
SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.t? DESC
IOWriteslong

I/O 写次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
MaxIOWriteslong

最大 I/O 写次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
LastRowsCountAffectedlong

最后一条语句的影响行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
MaxLastRowsCountAffectedlong

最大最后一条语句的影响行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
LogicalIOReadslong

逻辑读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
MaxLogicalIOReadslong

最大逻辑读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
PhysicalIOReadslong

物理读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
MaxPhysicalIOReadslong

最大物理读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
RowsCountAffectedlong

影响的行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
MaxRowsCountAffectedlong

最大影响的行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
CPUTimedouble

已废弃。

-
AvgCPUTimedouble

已废弃。

-
MaxCPUTimedouble

已废弃。

-
AvgIOWritesdouble

平均 I/O 写次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
AvgLastRowsCountAffecteddouble

平均最后一条语句的影响行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
AvgLogicalIOReadsdouble

平均逻辑读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
AvgPhysicalIOReadsdouble

平均物理读次数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
AvgRowsCountAffecteddouble

平均影响的行数。

说明 仅云数据库 RDS SQL Server 版实例支持。
1000
ErrorCodeinteger

错误码。

10910
Messagestring

错误信息。

Successful
Timestamplong

请求时间。

1735104224250

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "52D540CF-C517-1F57-BB42-9035F96******",
  "Success": "true",
  "Data": {
    "RequestKey": "123456789",
    "ResultId": "async__665ee69612f1627c7fd9f3c85075****",
    "State": "SUCCESS",
    "IsFinish": true,
    "Data": {
      "DbInstanceName": "0",
      "NodeId": "pi-wz99g5rn7w1x8h0sf",
      "ItemsNumbers": 10,
      "StartTime": "2024-10-08T02:01:00Z",
      "EndTime": "2024-08-08T02:15:00Z",
      "DbInstanceId": 0,
      "TotalRecords": 13,
      "PageNumbers": 1,
      "MaxRecordsPerPage": 10,
      "Logs": [
        {
          "Count": 12,
          "MaxLockTime": 0,
          "MaxQueryTime": 0,
          "MaxRowsExamined": 318613,
          "MaxRowsSent": 256,
          "AvgQueryTime": 0,
          "QueryTimeRate": 0.1018,
          "CountRate": 0.2034,
          "AvgRowsExamined": 53421,
          "OriginAlias": "order-1",
          "User": "user-1",
          "SqlTag": {
            "SqlId": "a3931d8c3a9315dd5ed016d71cf*****",
            "Tags": "DAS_IN_PLAN",
            "Comments": "dba 归档"
          },
          "Trend": [
            {
              "Timestamp": 1723775362,
              "Value": "tf-testacc-oos-parameter"
            }
          ],
          "Database": "work-wechat-api",
          "Histogram": {
            "Total": 7,
            "Count": [
              100
            ],
            "Ts": [
              1715220818
            ],
            "TsEnd": [
              0
            ],
            "Item": [
              {
                "NodeId": "r-bp1s1m8hwzrm77kfvz-db-0",
                "Count": [
                  100
                ]
              }
            ],
            "Rt": [
              1854
            ],
            "AvgRt": [
              3709
            ],
            "MaxRt": [
              2516
            ],
            "LockTime": [
              300
            ],
            "AvgLockTime": [
              15
            ],
            "MaxLockTime": [
              1051
            ],
            "RowsExamined": [
              641057
            ],
            "AvgRowsExamined": [
              222189
            ],
            "MaxRowsExamined": [
              878511
            ],
            "RowsSent": [
              4
            ],
            "AvgRowsSent": [
              2
            ],
            "MaxRowsSent": [
              256
            ]
          },
          "SqlId": "2dca88762ec6b3812504ab8a4b******",
          "Scheme": "HTTP",
          "SubInstanceId": "r-8vba51c588ba3a94",
          "DbInstanceName": "0",
          "InsName": "rm-uf6zix1z2jh1y6fe5",
          "AccountName": "edu_admin",
          "HostAddress": "172.23.142.178",
          "QueryStartTime": "2024-12-25T03:00:00Z",
          "SQLText": "SELECT 'Hello, World!' FROM DUAL",
          "Psql": "SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.id DESC",
          "DBName": "member_score",
          "QueryTime": 272.444,
          "ReturnItemNumbers": "暂无",
          "DocsExamined": 1,
          "KeysExamined": 20000,
          "TableName": "users\\nifconfig\\n",
          "LockTime": 0,
          "RowsExamined": 2444081,
          "RowsSent": 772,
          "ThreadId": "1",
          "Timestamp": 1708568930,
          "AvgLockTime": 0,
          "AvgRowsSent": 2,
          "LockTimeSeconds": 0,
          "QueryTimeSeconds": 25.472,
          "AvgLockTimeSeconds": 0,
          "MaxLockTimeSeconds": 0,
          "MaxQueryTimeSeconds": 14.402,
          "AvgQueryTimeSeconds": 6.211,
          "SqlType": "LOGIN",
          "QueryId": "sq-1pzcdMwRb",
          "NodeType": "DLNode",
          "HostInsId": "mongo-abc123456",
          "InsRole": "__system",
          "OpType": "Insert",
          "Namespace": "database.collection",
          "AvgKeysExamined": 20000,
          "AvgDocExamined": 10000,
          "AvgReturnNum": 1,
          "MaxKeysExamined": 2000000,
          "MaxDocExamined": 1000000,
          "MaxReturnNum": 1,
          "ReturnNum": 1,
          "DocExamined": 2000000,
          "Command": "SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.t? DESC",
          "IOWrites": 1000,
          "MaxIOWrites": 1000,
          "LastRowsCountAffected": 1000,
          "MaxLastRowsCountAffected": 1000,
          "LogicalIOReads": 1000,
          "MaxLogicalIOReads": 1000,
          "PhysicalIOReads": 1000,
          "MaxPhysicalIOReads": 1000,
          "RowsCountAffected": 1000,
          "MaxRowsCountAffected": 1000,
          "CPUTime": 0,
          "AvgCPUTime": 0,
          "MaxCPUTime": 0,
          "AvgIOWrites": 1000,
          "AvgLastRowsCountAffected": 1000,
          "AvgLogicalIOReads": 1000,
          "AvgPhysicalIOReads": 1000,
          "AvgRowsCountAffected": 1000
        }
      ]
    },
    "ErrorCode": 10910,
    "Message": "Successful",
    "Timestamp": 1735104224250
  }
}

错误码

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

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