全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeSlowLogs - 查询PolarDB集群的慢日志统计信息

    文档中心

    云原生数据库 PolarDB：DescribeSlowLogs - 查询PolarDB集群的慢日志统计信息

    更新时间：Aug 29, 2024

    查询PolarDB集群的慢日志统计信息。

    接口说明

    说明
  • 仅 PolarDB MySQL 版支持该接口。
  • 2024 年 09 月 01 日起，由于 SQL 模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。【通知】慢 SQL 的模板化算法优化。
    •

    调试

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

    授权信息

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

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

    请求参数

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

    地域 ID。

    		cn-hangzhou
    DBClusterIdstring是

    集群 ID。

    		pc-****************
    StartTimestring是

    查询开始日期，格式：yyyy-MM-ddZ（UTC 时间）。

    		2021-05-01Z
    EndTimestring是

    查询结束日期，不能小于查询开始日期，与查询开始日期间隔不超过 31 天。格式：yyyy-MM-ddZ（UTC 时间）。

    		2021-05-30Z
    DBNamestring否

    数据库名称。

    		PolarDB_MySQL
    PageSizeinteger否

    每页记录数，取值：30~100。默认值：30。

    		30
    PageNumberinteger否

    页码，取值：大于 0 且不超过 Integer 的最大值。

    默认值：1。

    		1

    返回参数

    名称类型描述示例值
    object
    TotalRecordCountinteger

    总记录数。

    		5
    PageRecordCountinteger

    本页 SQL 语句个数。

    		6
    EndTimestring

    查询结束日期。

    		2021-05-30Z
    RequestIdstring

    请求 ID。

    		2553A660-E4EB-4AF4-A402-8AFF70A49143
    PageNumberinteger

    页码。

    		3
    StartTimestring

    查询开始日期。

    		2021-05-01Z
    DBClusterIdstring

    集群 ID。

    		pc-****************
    Itemsarray<object>

    慢日志信息列表。

    object
    SQLTextstring

    SQL 语句。

    		select id,name from tb_table
    ReturnMaxRowCountlong

    返回的 SQL 行数（最大值）。

    		3
    CreateTimestring

    数据生成日期。

    		2021-05-30Z
    MaxExecutionTimelong

    执行时长（最大值），单位：秒。

    		60
    ParseTotalRowCountslong

    解析的 SQL 行数（总值）。

    		2
    TotalLockTimeslong

    锁定时长（总值），单位：秒。

    		1
    TotalExecutionTimeslong

    执行时长（总值），单位：秒。

    		2
    DBNodeIdstring

    节点 ID。

    		pi-***************
    SQLHASHstring

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

    		U2FsdGVkxxxx
    ParseMaxRowCountlong

    解析的 SQL 行数（最大值）。

    		1
    MaxLockTimelong

    锁定时长（最大值），单位：秒。

    		1
    ReturnTotalRowCountslong

    返回的 SQL 行数（总值）。

    		1
    DBNamestring

    数据库名称。

    		PolarDB_MySQL
    TotalExecutionCountslong

    执行次数（总值）。

    		2
    Enginestring

    数据库引擎。

    		polardb_mysql

    示例

    正常返回示例

    JSON格式

    {
  "TotalRecordCount": 5,
  "PageRecordCount": 6,
  "EndTime": "2021-05-30Z",
  "RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143",
  "PageNumber": 3,
  "StartTime": "2021-05-01Z",
  "DBClusterId": "pc-****************",
  "Items": {
    "SQLSlowLog": [
      {
        "SQLText": "select id,name from tb_table",
        "ReturnMaxRowCount": 3,
        "CreateTime": "2021-05-30Z",
        "MaxExecutionTime": 60,
        "ParseTotalRowCounts": 2,
        "TotalLockTimes": 1,
        "TotalExecutionTimes": 2,
        "DBNodeId": "pi-***************",
        "SQLHASH": "U2FsdGVkxxxx",
        "ParseMaxRowCount": 1,
        "MaxLockTime": 1,
        "ReturnTotalRowCounts": 1,
        "DBName": "PolarDB_MySQL",
        "TotalExecutionCounts": 2
      }
    ]
  },
  "Engine": "polardb_mysql"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.指定的参数StartTime无效

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

    变更历史

    变更时间变更内容概要操作
    2023-06-12OpenAPI 错误码发生变更查看变更详情
    2022-04-21新增 OpenAPI查看变更详情