云数据库 PostgreSQL 创建备份计划-备份与恢复相关接口-API 中心-腾讯云

1. 接口描述

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

此接口用于创建备份策略。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBackupPlan。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID。示例值：postgres-herclkx7
PlanName	是	String	备份计划名称。示例值：panl1
BackupPeriodType	是	String	创建的备份计划类型，当前仅支持month创建。示例值：month
BackupPeriod.N	是	Array of String	备份的日期，示例是每个月的2号开启备份。示例值：['2']
MinBackupStartTime	否	String	备份开始时间，不传跟随默认备份计划。示例值：01:00:00
MaxBackupStartTime	否	String	备份结束时间，不传跟随默认计划。示例值：02:00:00
BaseBackupRetentionPeriod	否	Integer	数据备份保留时长，week默认是7,month为30。示例值：30

3. 输出参数

参数名称	类型	描述
PlanId	String	备份策略的ID. 示例值：0ee6843a-475b-5514-bd29-c432b75bb036
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建月度制备份策略。

创建一个名字为plan1的备份策略，每个月的1/2号的凌晨1点至2点进行数据备份，并且数据文件保留40天。

输入示例

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

{
    "PlanName": "plan1",
    "BackupPeriodType": "month",
    "DBInstanceId": "postgres-kwk4tq23",
    "MinBackupStartTime": "01:00:00",
    "MaxBackupStartTime": "02:00:00",
    "BackupPeriod": [
        "1",
        "2"
    ],
    "BaseBackupRetentionPeriod": "40"
}

输出示例

{
    "Response": {
        "RequestId": "8a61e500-aa33-454c-9ec2-da2a368c39ab",
        "PlanId": "1111111"
    }
}

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.DatabaseAffectedError	数据操作失败，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
FailedOperation.PreCheckError	操作预检查失败。
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterLengthLimitError	参数长度超过限制。
OperationDenied.InstanceStatusLimitOpError	实例状态限制当前操作。

创建备份计划

本页目录：