tencent cloud

TencentDB for PostgreSQL

DocumentationTencentDB for PostgreSQL​​API ReferenceBackup and Recovery APIsDescribeDBXlogs

DescribeDBXlogs

Download
Focus Mode
Font Size
Last updated: 2026-05-21 10:44:19

1. API Description

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

This api is used to get instance Xlog list. This interface belongs to early api and has stopped feature iteration. We recommend using api DescribeLogBackups as substitution.

A maximum of 1000 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: DescribeDBXlogs.
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. for example, postgres-4wdeb0zv.
StartTime Yes Timestamp Query start time, such as 2018-06-10 17:06:38. start time should not be less than 7 days ago.
EndTime Yes Timestamp Query end time, in the format of 2018-06-10 17:06:38.
Offset No Integer Pagination return indicates which page of entries to return. counting begins from page 0.
Limit No Integer Pagination return indicates how many items per page. value range: 1-100.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Indicates how many data entries are returned.
XlogList Array of Xlog Xlog list.
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 Xlog list of the instance "postgres-apzvwncr"

u200cu200cu200cu200cu200cu200cThis example shows you how to query the full backup list of the database instance "postgres-6fego161" from 2018-06-10 17:06:38 to 2018-06-11 17:06:38.

Input Example

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

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

Output Example

{
    "Response": {
        "TotalCount": 6,
        "XlogList": [
            {
                "StartTime": "2018-06-22 01:56:46",
                "InternalAddr": "http://172.16.16.30:8366/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==",
                "EndTime": "2018-06-22 01:56:53",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==",
                "Id": 450,
                "Size": 247967
            },
            {
                "StartTime": "2018-06-22 01:56:17",
                "InternalAddr": "http://172.16.16.30:8366/download/20180622015617_20180622015645.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3Eamxg5sq4mNUSXLgasiI8P5xiJVUBOrLUPKLYacTxFWP8y56/f36byxdYH5+PGMzOA==",
                "EndTime": "2018-06-22 01:56:45",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180622015617_20180622015645.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3Eamxg5sq4mNUSXLgasiI8P5xiJVUBOrLUPKLYacTxFWP8y56/f36byxdYH5+PGMzOA==",
                "Id": 450,
                "Size": 899618
            },
            {
                "StartTime": "2018-06-22 01:56:10",
                "InternalAddr": "http://172.16.16.30:8366/download/20180622015610_20180622015610.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EWUN67hkmzzI32w2wS4KNi5jqNoaHxSJ59WJ9lrYebaz9SZgdOXyUBxlFmOGNchE3Q==",
                "EndTime": "2018-06-22 01:56:10",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180622015610_20180622015610.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EWUN67hkmzzI32w2wS4KNi5jqNoaHxSJ59WJ9lrYebaz9SZgdOXyUBxlFmOGNchE3Q==",
                "Id": 450,
                "Size": 41749
            },
            {
                "StartTime": "2018-06-21 01:55:49",
                "InternalAddr": "http://172.16.16.30:8366/download/20180621015549_20180621015557.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLPjSmz1BP/DJbQOeznMtdJsr77l4alcITO6f+jyIZ0upCYIFZhCIO2iJSzDXktIsGg==",
                "EndTime": "2018-06-21 01:55:57",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015549_20180621015557.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLPjSmz1BP/DJbQOeznMtdJsr77l4alcITO6f+jyIZ0upCYIFZhCIO2iJSzDXktIsGg==",
                "Id": 450,
                "Size": 247941
            },
            {
                "StartTime": "2018-06-21 01:55:20",
                "InternalAddr": "http://172.16.16.30:8366/download/20180621015520_20180621015548.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLNhfLPY0y78Bi9G0LEDTC70hI3QKhTP7jWZT/+e51oyIRW6hm8MoEKQ2DyBqjqvtaQ==",
                "EndTime": "2018-06-21 01:55:48",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015520_20180621015548.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLNhfLPY0y78Bi9G0LEDTC70hI3QKhTP7jWZT/+e51oyIRW6hm8MoEKQ2DyBqjqvtaQ==",
                "Id": 450,
                "Size": 899646
            },
            {
                "StartTime": "2018-06-21 01:55:13",
                "InternalAddr": "http://172.16.16.30:8366/download/20180621015513_20180621015513.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLKcr1q+wVdmFDDcdUtRcVsPlqfMXXg63tRWRtX/jFz6/MNbKg3r+EDkD5NdLA4nWhw==",
                "EndTime": "2018-06-21 01:55:13",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015513_20180621015513.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTGXfsNyKOxst2LTlcd0/LLKcr1q+wVdmFDDcdUtRcVsPlqfMXXg63tRWRtX/jFz6/MNbKg3r+EDkD5NdLA4nWhw==",
                "Id": 450,
                "Size": 41744
            }
        ],
        "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.FailedOperationError Operation failed. Please try again later.
FailedOperation.OssAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OssOperationFailed Failed to request the backend API.
FailedOperation.PresignedURLGetError An error occurred while getting the pre-signed authorization URL.
FailedOperation.StorePathSplitError Incorrect storage path format
InternalError.DBError Backend database execution error.
InternalError.InstanceDataError Failed to access database management service. Please contact customer service.
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.
InvalidParameterValue.IllegalRegion Invalid Region 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.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
Previous Topic: ModifyBackupDownloadRestrictionNext Topic: DescribeDBBackups

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback