tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBackupSummaries

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

    1. API Description

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

    This API is used to query the backup statistics of an instance. It will return the number and size (bytes) of backups of the instance.

    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: DescribeBackupSummaries.
    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.
    Limit No Integer The maximum number of results returned per page. Value range: 1-100. Default: 10
    Offset No Integer Data offset, which starts from 0.
    Filters.N No Array of Filter Filter instances using one or more criteria. Valid filter names:
    db-instance-id: Filter by instance ID (in string format).
    db-instance-name: Filter by instance name (in string format).
    db-instance-ip: Filter by instance VPC IP (in string format).
    OrderBy No String Sorting field. Valid values: TotalBackupSize, LogBackupSize, ManualBaseBackupSize, AutoBaseBackupSize.
    OrderByType No String Sorting order. Valid values: asc (ascending), desc (descending).

    3. Output Parameters

    Parameter Name Type Description
    BackupSummarySet Array of BackupSummary Backup statistics list.
    TotalCount Integer Number of all queried backups.
    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 backup statistics

    Input Example

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

{
    "Limit": 20,
    "Offset": 0,
    "OrderByType": "desc"
}

    Output Example

    {
    "Response": {
        "BackupSummarySet": [
            {
                "AutoBaseBackupCount": 3,
                "AutoBaseBackupSize": 3535342436352,
                "DBInstanceId": "postgres-lsw5y0bp",
                "LogBackupCount": 2,
                "LogBackupSize": 167792640,
                "ManualBaseBackupCount": 1,
                "ManualBaseBackupSize": 1178447478784,
                "TotalBackupCount": 6,
                "TotalBackupSize": 4713957707776
            }
        ],
        "RequestId": "3929dd3a-d95d-4ec2-ae69-a98317ce24fa",
        "TotalCount": 10
    }
}

    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
    FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.DatabaseAffectedError Data operation failed. Please contact customer service.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy