API 文档

查询实例备份列表

最近更新时间:2022-01-13 08:56:11

我的收藏

1. 接口描述

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

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

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

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

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。(当该参数不传或者传0时按默认值处理)
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
&Type=1
&StartTime=2018-06-10 17:06:38
&EndTime=2018-06-11 17:06:38
&Limit=20
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "BackupList": [
      {
        "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
      },
      {
        "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. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 鉴权失败。
FailedOperation.CamSigAndAuthError 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
FailedOperation.OssAccessError 访问管控服务失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.OssOperationFailed 请求后端接口失败。
FailedOperation.PresignedURLGetError 获取预签名授权URL错误。
FailedOperation.StorePathSplitError 存储路径格式不正确。
InternalError.DBError 后台DB执行错误。
InternalError.InstanceDataError 管控系统元数据访问异常,请联系客服处理。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InvalidParameterValue.IllegalRegion 非法的Region参数。
InvalidParameterValue.InstanceNotExist 当前实例不存在。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
InvalidParameterValue.ParameterHandleError 参数处理失败,请检参数值设置是否有效。
OperationDenied.CamDeniedError 当前操作被限制。
OperationDenied.InstanceAccessDeniedError 您没有权限操作当前资源。
ResourceNotFound.InstanceNotFoundError 实例不存在。
UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
目录