1. 接口描述
接口请求域名： cbs.tencentcloudapi.com 。
本接口（ModifySnapshotAttribute）用于修改指定快照的属性。
- 本接口支持修改快照名称及到期时间，以及将非永久快照修改为永久快照。
- “快照名称”仅为方便用户管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifySnapshotAttribute。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SnapshotId | 是 | String | 快照ID, 可通过DescribeSnapshots查询。 示例值：snap-gybrif0z |
| IsPermanent | 否 | Boolean | 快照的保留方式，FALSE表示非永久保留，TRUE表示永久保留。 示例值：true |
| SnapshotName | 否 | String | 新的快照名称。最长为60个字符。 示例值：snap_201711301143 |
| Deadline | 否 | Timestamp ISO8601 | 快照的到期时间；设置好快照将会被同时设置为非永久保留方式；超过到期时间后快照将会被自动删除。 示例值：2021-06-28 00:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改快照的名称
修改某个快照的名称
输入示例
https://cbs.tencentcloudapi.com/?Action=ModifySnapshotAttribute
&SnapshotId=snap-gybrif0z
&SnapshotName=snap_201711301143
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InvalidSnapshot.NotSupported | 快照不支持该操作。 |
| InvalidSnapshotId.NotFound | 输入的SnapshotId不存在。 |
| MissingParameter | 缺少参数错误。 |
| UnsupportedOperation.SnapHasShared | 该快照已经共享，请先解除共享。 |
| UnsupportedOperation.SnapshotHasBindedImage | 该快照创建了自定义快照，请先删除对应镜像。 |