# 更新快照 - CinderUpdateSnapshotV3 #### 功能介绍 更新快照。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /v3/{project_id}/snapshots/{snapshot_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | snapshot_id | 是 | String | 快照ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | snapshot | 是 | [CinderUpdateSnapshotOption] object | 待更新的快照信息。 | 表4CinderUpdateSnapshotOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 云硬盘快照名称。最大支持64个字符。 说明： 对云硬盘创建备份时，同时会创建以autobk_snapshot_为名称前缀的快照， 云硬盘控制台对此类快照会有操作限制。因此建议不要创建以 autobk_snapshot_为名称前缀的快照，避免影响快照的正常使用。 | | description | 否 | String | 云硬盘快照描述。最大支持85个字符。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshot | [SnapshotSummary] object | 快照信息。 | 表6SnapshotSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | created_at | String | 云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | description | String | 云硬盘快照描述信息。 | | id | String | 云硬盘快照ID。 | | metadata | Map\ | 云硬盘快照的元数据信息。 如果元数据中包含__system__enableActive字段，则表示该快照为云服务器创建备份时自动生成的快照。 | | name | String | 云硬盘快照名称。 | | size | Integer | 云硬盘快照大小，单位为GiB。 | | status | String | 云硬盘快照状态，具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | updated_at | String | 快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | volume_id | String | 快照所属的云硬盘ID。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误信息。 **取值范围** 不涉及。 | 表8Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请[参考错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 ``` PUT https://{endpoint}/v3/{project_id}/snapshots/{snapshot_id} { "snapshot" : { "name" : "name_xx3", "description" : "hello" } } ``` #### 响应示例 **状态码：200** OK ``` { "snapshot" : { "status" : "available", "description" : "Daily backup", "created_at" : "2013-02-25T03:56:53.081642", "metadata" : { }, "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "size" : 1, "id" : "f9faf7df-fdc1-4093-9ef3-5cba06eef995", "name" : "snap-001", "updated_at" : "2013-02-25T03:56:53.081642" } } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "EVS.XXX" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。