1. 接口描述
接口请求域名： cbs.tencentcloudapi.com 。
本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。
- 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
- 修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyAutoSnapshotPolicyAttribute。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| AutoSnapshotPolicyId | 是 | String | 定期快照策略ID。 示例值：asp-nqu08k2l |
| IsActivated | 否 | Boolean | 是否激活定期快照策略，FALSE表示未激活，TRUE表示激活，默认为TRUE。 示例值：1 |
| IsPermanent | 否 | Boolean | 通过该定期快照策略创建的快照是否永久保留。FALSE表示非永久保留，TRUE表示永久保留，默认为FALSE。 示例值：TRUE |
| AutoSnapshotPolicyName | 否 | String | 要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。 示例值：data_disk_auto_snapshot |
| Policy.N | 否 | Array of Policy | 定期快照的执行策略。 |
| RetentionDays | 否 | Integer | 通过该定期快照策略创建的快照保留天数。如果指定本参数，则IsPermanent入参不可指定为TRUE，否则会产生冲突。 示例值：6 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 启用自动快照策略
启用自动快照策略
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<公共请求参数>
{
"AutoSnapshotPolicyId": "asp-01928374",
"IsActivated": "true"
}输出示例
{
"Response": {
"RequestId": "88a4815c-4a09-4948-b0c9-fa6fdefe8e4a"
}
}示例2 修改定期快照策略属性
修改该定期快照策略的名称为data_disk_auto_snapshot，且将IsPermanent置为TRUE，通过该定期快照策略创建的快照为永久保留的快照。
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAutoSnapshotPolicyAttribute
<公共请求参数>
{
"AutoSnapshotPolicyId": "asp-nqu08k2l",
"AutoSnapshotPolicyName": "data_disk_auto_snapshot",
"IsPermanent": "TRUE"
}输出示例
{
"Response": {
"RequestId": "384c1fa8-6973-9623-b6bf-5a1fa9a7ad88"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidAccount.InsufficientBalance | 账户余额不足。 |
| InvalidAutoSnapshotPolicyId.NotFound | 输入的AutoSnapshotPolicyId不存在。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnsupportedOperation.StateError | 资源当前状态不支持该操作。 |
