创建定期快照策略

最近更新时间:2019-07-24 15:06:51

1. 接口描述

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

本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。

  • 每个地域可创建的定期快照策略数量限制请参考文档定期快照
  • 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAutoSnapshotPolicy
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
Policy.N Array of Policy 定期快照的执行策略。
AutoSnapshotPolicyName String 要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。
IsActivated Boolean 是否激活定期快照策略,FALSE表示未激活,TRUE表示激活,默认为TRUE。
IsPermanent Boolean 通过该定期快照策略创建的快照是否永久保留。FALSE表示非永久保留,TRUE表示永久保留,默认为FALSE。
RetentionDays Integer 通过该定期快照策略创建的快照保留天数,默认保留7天。如果指定本参数,则IsPermanent入参不可指定为TRUE,否则会产生冲突。
DryRun Boolean 是否创建定期快照的执行策略。TRUE表示只需获取首次开始备份的时间,不实际创建定期快照策略,FALSE表示创建,默认为FALSE。

3. 输出参数

参数名称 类型 描述
AutoSnapshotPolicyId String 新创建的定期快照策略ID。
NextTriggerTime String 首次开始备份的时间。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建定期快照策略

创建一个定期快照策略,绑定该定期快照策略的云盘会在每周5的0点创建快照。

输入示例

https://cbs.tencentcloudapi.com/?Action=CreateAutoSnapshotPolicy
&AutoSnapshotPolicyName=backup_data_friday
&Policy.0.DayOfWeek.0=4
&Policy.0.Hour.0=0
&<公共请求参数>

输出示例

{
  "Response": {
    "AutoSnapshotPolicyId": "asp-1lebc9r3",
    "NextTriggerTime": "2018-08-08 16:00:00",
    "RequestId": "88d95732-c4e9-bd97-4a23-5a1f978d3b72"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AutoSnapshotPolicyOutOfQuota 定期快照策略数量已达到上限。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
MissingParameter 参数缺失。请求没有带必选参数。