tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBBackups

Last updated: 2024-06-17 14:26:34

    1. API Description

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

    This API is used to query the backup list of an instance. This API is disused and replaced by the DescribeBaseBackups API.

    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: DescribeDBBackups.
    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-4wdeb0zv.
    Type Yes Integer Backup mode (1: full). Currently, only full backup is supported. The value is 1.
    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
    Limit No Integer Number of entries to be returned per page for backup list. Default value: 20. Minimum value: 1. Maximum value: 100. (If this parameter is left empty or 0, the default value will be used)
    Offset No Integer Page number for data return in paged query. Pagination starts from 0. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of backup files in the returned backup list
    BackupList Array of DBBackup Backup 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 Querying the list of backups for the instance "postgres-6fego161"

    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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBBackups
<Common request parameters>

{
    "DBInstanceId": "postgres-6fego161",
    "Limit": "20",
    "StartTime": "2018-06-10 17:06:38",
    "Offset": "0",
    "EndTime": "2018-06-11 17:06:38",
    "Type": "1"
}

    Output Example

    {
    "Response": {
        "TotalCount": 2,
        "BackupList": [
            {
                "SetId": "f77ecd1a-087c-5c66-8c35-95c835d7ec24",
                "Status": 2,
                "InternalAddr": "http://172.16.16.30:8366/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=",
                "StartTime": "2018-06-22 01:56:01.181971",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=",
                "Strategy": 1,
                "DbList": [
                    "db1"
                ],
                "Way": 1,
                "EndTime": "2018-06-22 01:56:55.071181",
                "Type": 1,
                "Id": 450,
                "Size": 3654968
            },
            {
                "SetId": "f6yecd1a-087c-5c66-cdas-95c835d7ec24",
                "Status": 2,
                "InternalAddr": "http://172.16.16.30:8366/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
                "StartTime": "2018-06-21 01:55:04.199169",
                "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
                "Strategy": 1,
                "DbList": [
                    "db2"
                ],
                "Way": 1,
                "EndTime": "2018-06-21 01:55:58.477232",
                "Type": 1,
                "Id": 450,
                "Size": 3654991
            }
        ],
        "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.
    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.
    UnsupportedOperation The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy