文档中心

云备份

备份策略

UpdateBackupPolicy - 更新备份策略

调用 UpdateBackupPolicy 更新备份策略。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：UpdateBackupPolicy

要执行的操作，取值：UpdateBackupPolicy。

Version string 必选示例值：2024-03-01

API的版本，取值：2024-03-01。

PolicyId string 必选示例值：policy-4ygbn2zgxj2rxnj6****

策略 ID。

Name string 可选示例值：cbr_policy_cn

策略名称。

EnablePolicy boolean 可选示例值：true

策略是否启用，取值说明如下：

true：启用策略。

false：禁用策略。

Crontab string 可选示例值：0 1,2 * * 1,4

备份周期，采用 crontab 表达式。

BackupType string 可选示例值：FULL

备份类型，取值说明如下：

FULL：全量备份。

INCREMENTAL：增量备份。

RetentionDay integer 可选示例值：30

恢复点保留时间，值为正整数，-1 表示持续保留，取值范围为 [-1，999999]。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateBackupPolicy&Version=2024-03-01 HTTP/1.1​
Host: cbr.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251017T093406Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251017/cn-beijing/cbr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "PolicyId": "policy-4ygbn2zgxj2rxnj6****"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20250421170030248217175039C37C16",​
    "Action": "UpdateBackupPolicy",​
    "Version": "2024-03-01",​
    "Service": "cbr",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ObjectNotExist	The specified object does not exist.	当前账号下不存在该对象。
400	InvalidParameter	The specified parameter %s is not valid.	参数值无效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。

最近更新时间：2025.10.31 18:11:02

这个页面对您有帮助吗？

有用

无用