云数据库 PostgreSQL 查询基础备份列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口 (DescribeBaseBackups) 用于查询基础备份列表。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBaseBackups。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
MinFinishTime	否	String	备份的最小结束时间，形如2018-01-01 00:00:00。默认为7天前。
MaxFinishTime	否	String	备份的最大结束时间，形如2018-01-01 00:00:00。默认为当前时间。
Filters.N	否	Array of Filter	按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string。 db-instance-name：按照实例名过滤，类型为string。 db-instance-ip：按照实例私有网络IP地址过滤，类型为string。
Limit	否	Integer	每页显示数量，取值范围为1-100，默认为返回10条。
Offset	否	Integer	数据偏移量，从0开始。
OrderBy	否	String	排序字段，支持StartTime,FinishTime,Size。
OrderByType	否	String	排序方式，包括升序：asc，降序：desc。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询到的基础备份数量。
BaseBackupSet	Array of BaseBackup	基础备份详细信息列表。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询基础备份列表

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBaseBackups
<公共请求参数>

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

输出示例

{
    "Response": {
        "BaseBackupSet": [
            {
                "BackupMethod": "physical",
                "BackupMode": "manual",
                "DBInstanceId": "postgres-9n26zs6n",
                "ExpireTime": "2023-02-18 23:59:59",
                "FinishTime": "2023-02-15 19:09:36",
                "Id": "88d3a71e-b822-5728-9d41-d8cfc0d0556e",
                "Name": "manual-20230215190924.tar.gz",
                "Size": 39845888,
                "StartTime": "2023-02-15 19:09:24",
                "State": "finished"
            }
        ],
        "RequestId": "3f164712-8746-464f-a490-3084a470000e",
        "TotalCount": 10
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.CamDeniedError	当前操作被限制。

动态与公告

产品简介

购买指南

快速入门

内核能力介绍

操作指南

ServerlessDB 相关

MSSQL 兼容版

最佳实践

API 文档

常见问题

相关协议

联系我们

词汇表

查询基础备份列表

本页目录：