查询实例备份列表

最近更新时间:2018-09-18 17:03:10

1. 接口描述

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

本接口(DescribeDBBackups)用于查询实例备份列表。

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:postgres.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBBackups
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DBInstanceId String 实例ID,形如postgres-4wdeb0zv。
Type Integer 备份方式(1-全量)。目前只支持全量,取值为1。
StartTime Timestamp 查询开始时间,形如2018-06-10 17:06:38,起始时间不得小于7天以前
EndTime Timestamp 查询结束时间,形如2018-06-10 17:06:38
Limit Integer 备份列表分页返回,每页返回数量,默认为 20,最小为1,最大值为 100。
Offset Integer 返回结果中的第几页,从第0页开始。默认为0。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回备份列表中备份文件的个数
BackupList Array of DBBackup 备份列表
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查询实例postgres-6fego161备份列表

输入示例

https://postgres.tencentcloudapi.com/?Action=DescribeDBBackups
&DBInstanceId=postgres-6fego161
&Region=ap-guangzhou
&Type=1
&StartTime=2018-06-10 17:06:38
&EndTime=2018-06-11 17:06:38
&Limit=20
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "BackupList": [
      {
        "DbList": null,
        "EndTime": "2018-06-22 01:56:55.071181",
        "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=",
        "Id": 450,
        "InternalAddr": "http://172.16.16.30:8366/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=",
        "Size": 3654968,
        "StartTime": "2018-06-22 01:56:01.181971",
        "Status": 2,
        "Strategy": 1,
        "Type": 1,
        "Way": 1
      },
      {
        "DbList": null,
        "EndTime": "2018-06-21 01:55:58.477232",
        "ExternalAddr": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
        "Id": 450,
        "InternalAddr": "http://172.16.16.30:8366/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
        "Size": 3654991,
        "StartTime": "2018-06-21 01:55:04.199169",
        "Status": 2,
        "Strategy": 1,
        "Type": 1,
        "Way": 1
      }
    ],
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InvalidParameterValue.IllegalRegion 非法的Region参数。
InvalidParameterValue.InstanceNotExist 当前实例不存在。