云数据库 PostgreSQL 查询备份集的下载地址-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口 (DescribeBackupDownloadURL) 用于查询指定备份集的下载地址，可包括全量备份集、增量日志备份集。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupDownloadURL。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID。示例值：postgres-xxxxxxxx
BackupType	是	String	备份类型，目前支持：LogBackup，BaseBackup。示例值：LogBackup
BackupId	是	String	备份的唯一ID。示例值：f6adc02a-432e-536f-a5f3-3dbf40ecd683
URLExpireTime	否	Integer	链接的有效时间，默认为12小时。示例值：12
BackupDownloadRestriction	否	BackupDownloadRestriction	备份下载限制示例值：{ "RestrictionType": "NONE", "VpcRestrictionEffect": "ALLOW", "VpcIdSet": [ "vpc-15ld6dhr" ], "IpRestrictionEffect": "ALLOW", "IpSet": [ "10.10.10.220" ] }

3. 输出参数

参数名称	类型	描述
BackupDownloadURL	String	备份的下载地址。示例值：https://postgres-backup-gz-xxxx.cos.ap-guangzhou.myqcloud.com/pgsql/xxxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取备份下载链接

获取备份下载链接

输入示例

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

{
    "DBInstanceId": "postgres-oamgybor",
    "BackupType": "LogBackup",
    "BackupId": "f9509fc2-2281-551c-b937-86d38cf79f3b",
    "URLExpireTime": 12
}

输出示例

{
    "Response": {
        "BackupDownloadURL": "******",
        "RequestId": "7c4e788e-5ec9-4125-bb80-7baabe2744dc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InternalError.InstanceDataError	管控系统元数据访问异常，请联系客服处理。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterValueExceedError	参数值超过上限。
OperationDenied.CamDeniedError	当前操作被限制。
OperationDenied.InstanceStatusLimitError	实例当前状态限制本次操作。
ResourceNotFound.InstanceNotFoundError	实例不存在。

查询备份集的下载地址

本页目录：