tencent cloud

All product documents
TencentDB for PostgreSQL
DocumentationTencentDB for PostgreSQLAPI DocumentationPerformance Optimization APIsDescribeDBErrlogs
DescribeDBErrlogs
Download PDF
Last updated: 2024-06-17 14:26:03
DescribeDBErrlogs
Last updated: 2024-06-17 14:26:03
Download PDF

1. API Description

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

This API is used to query an error log.

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: DescribeDBErrlogs.
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
StartTime Yes Timestamp u200cu200cu200cQuery start time in the format of 2018-01-01 00:00:00. The log is retained for seven days by default, so the start time must fall within the retention period.
EndTime Yes Timestamp u200cu200cu200cu200cQuery end time in the format of 2018-01-01 00:00:00
DatabaseName No String Database name
SearchKeys.N No Array of String Keywords used for search
Limit No Integer Number of results returned per page. Value range: 1-100. Default value: 50.
Offset No Integer Data offset, which starts from 0. Default value: 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of logs returned in a single query. Maximum value: 10000.
Details Array of ErrLogDetail Detailed sets of error logs
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 error logs

u200cu200cu200cu200cu200cu200cu200cThis example shows you how to get the error logs in a specified time range.

Input Example

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

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

Output Example

{
    "Response": {
        "TotalCount": 10,
        "RequestId": "061bdcc0-6845-431a-a85e-ff591a352760",
        "Details": [
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:22:52",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:22:52",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:09",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:10",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:10",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:11",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:11",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "postgres",
                "ErrTime": "2018-06-22 15:23:29",
                "ErrMsg": "WARNING:  there is no transaction in progress ",
                "Database": "dee"
            },
            {
                "UserName": "root",
                "ErrTime": "2018-06-22 15:25:01",
                "ErrMsg": "ERROR:  canceling autovacuum task CONTEXT:  automatic analyze of table \"dee.public.orders\" ",
                "Database": "dee"
            },
            {
                "UserName": "root",
                "ErrTime": "2018-06-22 15:25:10",
                "ErrMsg": "ERROR:  canceling autovacuum task CONTEXT:  automatic analyze of table \"dee.public.partsupp\" ",
                "Database": "dee"
            }
        ]
    }
}

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.FailedOperationError Operation failed. Please try again later.
InternalError.DBError Backend database execution error.
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.InterfaceNameNotFound Incorrect ACTION.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.ParameterValueExceedError The maximum value of the parameter has been reached.
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