DescribeSlowQueryList

Last updated: 2021-09-09 17:57:15

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to get the slow query list.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeSlowQueryList.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID.
StartTime Yes String Start timestamp of the query range in the format of "YYYY-MM-DD HH:mm:ss". The log is retained for seven days by default, so the start timestamp must fall within the retention period.
EndTime Yes String End timestamp of the query range in the format of "YYYY-MM-DD HH:mm:ss".
DatabaseName No String Filter by database name. This parameter is optional.
OrderByType No String Sorting order. Valid values: asc (ascending), desc (descending). Default value: desc.
OrderBy No String Sort by field. Valid values: SessionStartTime (default), Duration.
Limit No Integer Number of entries per page. Value range: [1,100]. Default value: 20.
Offset No Integer Pagination offset. Value range: [0,INF). Default value: 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of slow query statements during the specified period of time.
DurationAnalysis Array of DurationAnalysis Analysis of the execution time of slow query statements by classifying them to different time ranges. These slow query statements fall within the query range you specified in the request parameters.
Note: this field may return null, indicating that no valid values can be obtained.
RawSlowQueryList Array of RawSlowQuery The list of slow query details during the specified period of time.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the slow query list

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowQueryList
<Common request parameters>

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

Output Example

{
  "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterValueExceedError The maximum value of the parameter has been reached.
ResourceNotFound.InstanceNotFoundError The instance does not exist.