修改快照信息

最近更新时间:2018-09-18 16:56:39

1. 接口描述

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

本接口(ModifySnapshotAttribute)用于修改指定快照的属性。

  • 当前仅支持修改快照名称及将非永久快照修改为永久快照。
  • “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifySnapshotAttribute
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
SnapshotId String 快照ID, 可通过DescribeSnapshots查询。
SnapshotName String 新的快照名称。最长为60个字符。
IsPermanent Boolean 快照的保留时间,FALSE表示非永久保留,TRUE表示永久保留。仅支持将非永久快照修改为永久快照。

3. 输出参数

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

4. 示例

示例1 修改快照的名称

输入示例

https://cbs.tencentcloudapi.com/?Action=ModifySnapshotAttribute
&SnapshotId=snap-gybrif0z
&SnapshotName=snap_201711301143
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
InvalidSnapshot.NotSupported 快照不支持该操作。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
MissingParameter 参数缺失。请求没有带必选参数。

如果有其他疑问,你也可以通过提问形式与我们联系探讨