获取慢查询统计分析列表

最近更新时间:2024-06-07 02:17:27

我的收藏

1. 接口描述

接口请求域名: postgres.tencentcloudapi.com 。

此接口(DescribeSlowQueryAnalysis)用于统计指定时间范围内的所有慢查询,根据SQL语句抽象参数后,进行聚合分析,并返回同类SQL列表。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSlowQueryAnalysis。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBInstanceId String 实例ID。
示例值:postgres-xxx
StartTime String 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
示例值:2020-02-01 01:02:03
EndTime String 查询结束时间,形如2018-01-01 00:00:00。
示例值:2020-02-01 01:02:03
DatabaseName String 数据库名字。
示例值:postgres
OrderBy String 排序字段,取值范围[CallNum,CostTime,AvgCostTime]。默认值为CallNum。
示例值:CallNum
OrderByType String 排序方式,包括升序:asc 降序:desc。默认值为desc。
示例值:desc
Limit Integer 每页显示数量,取值范围为1-100。默认值为50。
示例值:20
Offset Integer 数据偏移量,从0开始。默认值为0。
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询到的总条数,最大值为10000条。
示例值:5
Detail Detail 查询到的慢SQL统计分析详细信息集合。
示例值:[ { "Advanced": false, "ClassificationCN": "连接和认证", "ClassificationEN": "Connections and Authentication", "CurrentValue": "2048", "DefaultValue": "2048", "EnumValue": null, "ID": 15124, "LastModifyTime": "", "Max": 2048, "Min": 100, "Name": "max_connections", "NeedReboot": true, "ParamDescriptionCH": "实例最大连接数", "ParamDescriptionEN": "Sets the maximum number of concurrent connections.", "ParamValueType": "integer", "SpecRelated": true, "SpecRelationSet": null, "StandbyRelated": 0, "Unit": "", "VersionRelationSet": null } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 慢查询统计分析接口实例

获取指定时间范围内实例的慢查询统计分析结果。

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowQueryAnalysis
<公共请求参数>

{
    "StartTime": "2021-06-17 20:00:07",
    "EndTime": "2021-06-17 20:15:07",
    "Limit": 10,
    "Offset": 0,
    "DBInstanceId": "postgres-nbvqjlhf"
}

输出示例

{
    "Response": {
        "Detail": {
            "AnalysisItems": [
                {
                    "AvgCostTime": 101.01300048828125,
                    "ClientAddr": "",
                    "CostPercent": 11.703700311890035,
                    "CostTime": 101.01300048828125,
                    "DatabaseName": "postgres",
                    "FirstTime": "2021-07-27 03:12:01",
                    "LastTime": "2021-07-27 03:12:01",
                    "MaxCostTime": 101.01300048828125,
                    "MinCostTime": 101.01300048828125,
                    "NormalQuery": "select $1 from information_schema.tables where table_schema = $2 and table_name = $3",
                    "UserName": "postgres"
                }
            ],
            "TotalCallNum": 6,
            "TotalTime": 863.0860137939453
        },
        "RequestId": "221334ddc4f",
        "TotalCount": 5
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ESQueryError ES查询失败,请稍后重试。如果持续不成功,请联系客服进行处理。
InternalError.InternalHttpServerError 请求执行异常。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
InvalidParameterValue.ParameterValueExceedError 参数值超过上限。
OperationDenied.CamDeniedError 当前操作被限制。
ResourceNotFound.InstanceNotFoundError 实例不存在。