DescribeSlowQueryAnalysis

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

1. API Description

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

This API is used to analyze slow query statements with abstract parameter values and return aggregated statistical analysis results.

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: DescribeSlowQueryAnalysis.
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.
OrderBy No String Sort by field. Valid values: CallNum, CostTime, AvgCostTime.
OrderByType No String Sorting order. Valid values: asc (ascending), desc (descending).
Limit No Integer Number of entries per page. Value range: [1,100].
Offset No Integer Pagination offset. Value range: [0,INF).

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of query results.
Detail Detail Detailed analysis.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Analyzing the slow queries of an instance

Input Example

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

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

Output Example

{
  "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. 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
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterValueExceedError The maximum value of the parameter has been reached.