修改备份计划

最近更新时间:2024-03-12 01:44:12

我的收藏

1. 接口描述

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

本接口 (ModifyBackupPlan) 用于实例备份计划的修改,默认是在每天的凌晨开始全量备份,备份保留时长是7天。可以根据此接口指定时间进行实例的备份。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyBackupPlan。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBInstanceId String 实例ID
示例值:postgres-xxxxxxxx
MinBackupStartTime String 实例最早开始备份时间
示例值:01:00:00
MaxBackupStartTime String 实例最晚开始备份时间
示例值:02:00:00
BaseBackupRetentionPeriod Integer 实例备份保留时长,取值范围为7-1830,单位是天
示例值:7
BackupPeriod.N Array of String 实例备份周期,按照星期维度,格式为小写星期英文单词
示例值:["monday", "tuesday", "wednesday"]
LogBackupRetentionPeriod Integer 实例日志备份保留时长,取值范围为7-1830,单位是天
示例值:7

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改实例备份计划

将实例postgres-xxxxxxxx的备份计划修改为每周一、周二的01:00:00~02:00:00,且备份保留7天

输入示例

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

{
    "BackupPeriod": [
        "tuesday",
        "monday"
    ],
    "BaseBackupRetentionPeriod": "7",
    "DBInstanceId": "postgres-xxxxxxxx",
    "MinBackupStartTime": "01:00:00",
    "MaxBackupStartTime": "02:00:00"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CamSigAndAuthError 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
InternalError.InternalHttpServerError 请求执行异常。
InvalidParameter.ParameterCheckError 参数检查失败。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.CamDeniedError 当前操作被限制。
OperationDenied.InstanceStatusLimitOpError 实例状态限制当前操作。
ResourceNotFound.InstanceNotFoundError 实例不存在。