云数据库 PostgreSQL 获取慢查询列表-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口（DescribeSlowQueryList）用于查询指定时间范围内的所有慢查询。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询到的慢日志数量，最大值为10000条。示例值：6
DurationAnalysis	Array of DurationAnalysis	查询到的慢日志耗时分段分析结果。注意：此字段可能返回 null，表示取不到有效值。示例值：[ { "Count": 0, "TimeSegment": "10-20s" }, { "Count": 0, "TimeSegment": "40-50s" } ]
RawSlowQueryList	Array of RawSlowQuery	查询到的慢日志详细信息集合。注意：此字段可能返回 null，表示取不到有效值。示例值：[ { "ClientAddr": "[local]", "DatabaseName": "postgres", "Duration": 101.013, "RawQuery": "select 1 from information_schema.tables where table_schema = 'pg_catalog' and table_name = 'pg_file_settings'", "SessionStartTime": "2021-07-27 03:12:01 CST", "UserName": "postgres" }, { "ClientAddr": "::1:34301", "DatabaseName": "postgres", "Duration": 155.283, "RawQuery": "select count(*)::text as value from pg_stat_activity where now()-backend_start < '5 second';", "SessionStartTime": "2021-07-25 02:25:09 CST", "UserName": "postgres" } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 慢日志列表查询示例

获取指定时间范围内实例的慢日志。

输入示例

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

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

输出示例

{
    "Response": {
        "DurationAnalysis": [
            {
                "Count": 0,
                "TimeSegment": "10-20s"
            },
            {
                "Count": 0,
                "TimeSegment": "40-50s"
            },
            {
                "Count": 0,
                "TimeSegment": "50s-"
            },
            {
                "Count": 0,
                "TimeSegment": "5-6s"
            },
            {
                "Count": 0,
                "TimeSegment": "6-7s"
            },
            {
                "Count": 0,
                "TimeSegment": "2-3s"
            },
            {
                "Count": 0,
                "TimeSegment": "20-30s"
            },
            {
                "Count": 0,
                "TimeSegment": "3-4s"
            },
            {
                "Count": 0,
                "TimeSegment": "4-5s"
            },
            {
                "Count": 0,
                "TimeSegment": "7-8s"
            },
            {
                "Count": 0,
                "TimeSegment": "8-9s"
            },
            {
                "Count": 0,
                "TimeSegment": "9-10s"
            },
            {
                "Count": 0,
                "TimeSegment": "30-40s"
            },
            {
                "Count": 6,
                "TimeSegment": "1-2s"
            }
        ],
        "RawSlowQueryList": [
            {
                "ClientAddr": "[local]",
                "DatabaseName": "postgres",
                "Duration": 101.013,
                "RawQuery": "select 1 from information_schema.tables where table_schema = 'pg_catalog' and table_name = 'pg_file_settings'",
                "SessionStartTime": "2021-07-27 03:12:01 CST",
                "UserName": "postgres"
            },
            {
                "ClientAddr": "::1:34301",
                "DatabaseName": "postgres",
                "Duration": 155.283,
                "RawQuery": "select count(*)::text as value from pg_stat_activity where now()-backend_start < '5  second';",
                "SessionStartTime": "2021-07-25 02:25:09 CST",
                "UserName": "postgres"
            },
            {
                "ClientAddr": "::1:34295",
                "DatabaseName": "postgres",
                "Duration": 168.119,
                "RawQuery": "select count(*)::text as value from pg_stat_activity where state='active';",
                "SessionStartTime": "2021-07-25 02:25:09 CST",
                "UserName": "postgres"
            },
            {
                "ClientAddr": "::1:34296",
                "DatabaseName": "postgres",
                "Duration": 168.757,
                "RawQuery": "select count(*)::text as value from pg_stat_activity where wait_event_type is not null",
                "SessionStartTime": "2021-07-25 02:25:09 CST",
                "UserName": "postgres"
            },
            {
                "ClientAddr": "::1:34298",
                "DatabaseName": "postgres",
                "Duration": 165.119,
                "RawQuery": "select application_name,COALESCE(pg_catalog.pg_wal_lsn_diff(sent_lsn, replay_lsn),0) from pg_stat_replication;",
                "SessionStartTime": "2021-07-25 02:25:09 CST",
                "UserName": "postgres"
            },
            {
                "ClientAddr": "::1:34297",
                "DatabaseName": "postgres",
                "Duration": 104.795,
                "RawQuery": "select count(*)::text as value from pg_stat_activity where state='idle';",
                "SessionStartTime": "2021-07-25 02:25:09 CST",
                "UserName": "postgres"
            }
        ],
        "RequestId": "221334ddcf",
        "TotalCount": 6
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.CamSigAndAuthError	鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAffectedError	数据操作失败，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InternalError.InternalHttpServerError	请求执行异常。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterValueExceedError	参数值超过上限。
OperationDenied.CamDeniedError	当前操作被限制。
OperationDenied.InstanceAccessDeniedError	您没有权限操作当前资源。
ResourceNotFound.InstanceNotFoundError	实例不存在。

获取慢查询列表

本页目录：