文档中心 API 中心 云硬盘 快照相关接口 修改定期快照策略信息

修改定期快照策略信息

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

1. 接口描述

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

本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。

  • 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
  • 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyAutoSnapshotPolicyAttribute
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
AutoSnapshotPolicyId String 定期快照策略ID。
Policy.N Array of Policy 定期快照的执行策略。
AutoSnapshotPolicyName String 要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。
IsActivated Boolean 是否激活定期快照策略,FALSE表示未激活,TRUE表示激活,默认为TRUE。
IsPermanent Boolean 通过该定期快照策略创建的快照是否永久保留。FALSE表示非永久保留,TRUE表示永久保留,默认为FALSE。
RetentionDays Integer 通过该定期快照策略创建的快照保留天数,该参数不可与IsPermanent参数冲突,即若定期快照策略设置为永久保留,RetentionDays应置0。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改定期快照策略属性

修改该定期快照策略的名称为data_disk_auto_snapshot,且将IsPermanent置为TRUE,通过该定期快照策略创建的快照为永久保留的快照。

输入示例

https://cbs.tencentcloudapi.com/?Action=ModifyAutoSnapshotPolicyAttribute
&AutoSnapshotPolicyId=asp-nqu08k2l
&AutoSnapshotPolicyName=data_disk_auto_snapshot
&IsPermanent=TRUE
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "384c1fa8-6973-9623-b6bf-5a1fa9a7ad88"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidAutoSnapshotPolicyId.NotFound 输入的AutoSnapshotPolicyId不存在。
InvalidParameter 参数错误
MissingParameter 参数缺失。请求没有带必选参数。
UnsupportedOperation.StateError 资源当前状态不支持该操作。