tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLPerformance Optimization APIsDescribeDBSlowlogs
DescribeDBSlowlogs
Last updated: 2024-06-17 14:26:02
DescribeDBSlowlogs
Last updated: 2024-06-17 14:26:02

1. API Description

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

This API is used to get a slow query log. Since it was deprecated on September 1, 2021, it has no longer returned data. You need to use the DescribeSlowQueryList API instead to get slow query logs.

A maximum of 100 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: DescribeDBSlowlogs.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
DBInstanceId Yes String Instance ID in the format of postgres-lnp6j617
StartTime Yes Timestamp Query start time in the format of 2018-06-10 17:06:38, which cannot be more than 7 days ago
EndTime Yes Timestamp Query end time in the format of 2018-06-10 17:06:38
DatabaseName No String Database name
OrderBy No String Metric for sorting. Valid values: sum_calls (total number of calls), sum_cost_time (total time consumed)
OrderByType No String Sorting order. desc: descending, asc: ascending
Limit No Integer Number of entries returned per page. Value range: 1-100. Default value: 20.
Offset No Integer Page number for data return in paged query. Pagination starts from 0

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of date entries returned this time
Detail SlowlogDetail Slow query log details
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting the slow query logs of an instance

This example shows you how to get slow query logs of the instance "postgres-apzvwncr".

Input Example

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

{
    "EndTime": "2018-06-11 17:06:38",
    "DBInstanceId": "postgres-apzvwncr",
    "StartTime": "2018-06-10 17:06:38"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "Detail": {
            "TotalTime": 0.0,
            "NormalQueries": [
                {
                    "UserName": "user",
                    "MaxCostTime": 0.0,
                    "Rows": 0,
                    "CostTime": 0.0,
                    "SharedReadBlks": 0,
                    "Calls": 0,
                    "WriteCostTime": 0,
                    "ReadCostTime": 0,
                    "CallsGrids": [
                        0
                    ],
                    "NormalQuery": "select 1;",
                    "MinCostTime": 0.0,
                    "DatabaseName": "postgres-apzvwncr",
                    "FirstTime": "2018-06-10 17:06:38",
                    "LastTime": "2018-06-11 17:06:38",
                    "SharedWriteBlks": 0
                }
            ],
            "TotalCalls": 0
        },
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
    }
}

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
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.ESConnectError Failed to access ES. Please try again later. If the problem persists, please contact customer service.
FailedOperation.ESQueryError Failed to query ES. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon