文档

DescribeSlowLogRecords - 查看慢日志明细

更新时间:

查看PolarDB集群的慢日志明细。

接口说明

说明
  • 仅 PolarDB MySQL 版集群支持调用该接口。
  • 自 2023 年 12 月 13 日起,由于慢 SQL 的模板化算法优化,调用本接口时,SQLHASH 字段的值将发生变更。详情请参见【通知】慢 SQL 的模板化算法优化
  • 调试

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

    授权信息

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

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

    请求参数

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

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看目标账号下的可用地域信息,包括地域 ID。
    cn-hangzhou
    DBClusterIdstring

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。
    pc-************
    StartTimestring

    查询开始时间。格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

    说明
  • 支持查看最多 30 天内的慢日志信息。
  • 该参数输入的是 UTC 时间(即 0 时区),如果您的服务当前处于其他时区,请您进行时间转换。例如,当前您的服务所在时区的时间是北京时间(UTC+8 时间)12:00 点,如果您需要查询北京时间 08:00 点-12:00 点的慢日志信息,那么应该输入的时间是 00:00 点-04:00 点。
  • 2022-11-15T16:00Z
    EndTimestring

    查询结束时间,需要晚于查询开始时间,且查询开始时间与结束时间的时间间隔需在 24 小时之内。格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

    说明 该参数输入的是 UTC 时间(即 0 时区),如果您的服务当前处于其他时区,请您进行时间转换。例如,当前您的服务所在时区的时间是北京时间(UTC+8 时间)12:00 点,如果您需要查询北京时间 08:00 点-12:00 点的慢日志信息,那么应该输入的时间是 00:00 点-04:00 点。
    2022-11-16T04:00Z
    DBNamestring

    数据库名称。

    testdb
    PageSizeinteger

    每页记录数,取值范围如下:

    • 30
    • 50
    • 100

    默认值为 30

    30
    PageNumberinteger

    页码,取值范围为大于 0 且不超过 Integer 的最大值。

    默认值为 1

    1
    SQLHASHstring

    慢日志统计里的 SQL 语句唯一标识符,可用于获取该 SQL 语句的慢日志明细。

    U2FsdGVk****

    返回参数

    名称类型描述示例值
    object
    TotalRecordCountinteger

    总 SQL 语句个数。

    1
    PageRecordCountinteger

    本页记录数。

    1
    RequestIdstring

    请求 ID。

    A7E6A8FD-C50B-46B2-BA85-D8B8D3******
    PageNumberinteger

    页码。

    1
    DBClusterIdstring

    集群 ID。

    pc-*****************
    Itemsobject []

    慢日志明细列表。

    ExecutionStartTimestring

    SQL 开始执行的时间。格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

    2021-04-07T03:47Z
    HostAddressstring

    连接数据库的客户端地址。

    testdb[testdb] @ [100.**.**.242]
    QueryTimeslong

    SQL 执行时长,单位为秒。

    20
    SQLTextstring

    查询语句。

    /* Query from *** by user 111 */ SELECT sleep(20)
    ReturnRowCountslong

    返回行数。

    0
    ParseRowCountslong

    解析行数。

    0
    DBNamestring

    数据库名称。

    testdb
    LockTimeslong

    SQL 锁定时长,单位为秒。

    0
    DBNodeIdstring

    节点 ID。

    pi-*****************
    QueryTimeMSlong

    查询时间。单位毫秒。

    100
    Enginestring

    数据库引擎。

    polardb_mysql

    示例

    正常返回示例

    JSON格式

    {
      "TotalRecordCount": 1,
      "PageRecordCount": 1,
      "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
      "PageNumber": 1,
      "DBClusterId": "pc-*****************",
      "Items": {
        "SQLSlowRecord": [
          {
            "ExecutionStartTime": "2021-04-07T03:47Z",
            "HostAddress": "testdb[testdb] @  [100.**.**.242]",
            "QueryTimes": 20,
            "SQLText": "/* Query from *** by user 111 */ SELECT sleep(20)",
            "ReturnRowCounts": 0,
            "ParseRowCounts": 0,
            "DBName": "testdb",
            "LockTimes": 0,
            "DBNodeId": "pi-*****************",
            "QueryTimeMS": 100
          }
        ]
      },
      "Engine": "polardb_mysql"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.指定的参数StartTime无效
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2023-06-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      新增错误码:400
      新增错误码:404