tencent cloud



Last updated: 2022-07-08 10:18:43

1. API Description

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

This API is used to count and analyze slow query statements during the specified period of time and return aggregated statistical analysis results which are classified by statement with abstract parameter values.

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

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 Params. The value used for this API: DescribeSlowQueryAnalysis.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. 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. Default value: CallNum.
OrderByType No String Sorting order. Valid values: asc (ascending), desc (descending). Default value: desc.
Limit No Integer Number of entries per page. Value range: [1,100]. Default value: 50.
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 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 slow queries of instance

Input Example

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


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
FailedOperation.ESQueryError Failed to query ES. Please try again later. If the problem persists, please contact customer service.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterValueExceedError The maximum value of the parameter has been reached.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support