云硬盘
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云硬盘 > API 文档 > 快照相关接口 > 创建定期快照策略

创建定期快照策略

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

我的收藏

本页目录：

1. 接口描述

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

本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
AutoSnapshotPolicyId String 新创建的定期快照策略ID。
示例值：asp-1lebc9r3
NextTriggerTime String 首次开始备份的时间。
示例值：2018-08-08 16:00:00
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建定期快照策略

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

输入示例

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

{
    "AutoSnapshotPolicyName": "backup_data_friday",
    "Policy": [
        {
            "DayOfWeek": [
                4
            ],
            "Hour": [
                0
            ]
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
LimitExceeded.AutoSnapshotPolicyOutOfQuota 定期快照策略数量已达到上限。
MissingParameter 缺少参数错误。
中国站