全部产品
Search
文档中心

云服务器 ECS:ModifySnapshotAttribute - 修改快照属性

更新时间:Nov 29, 2024

调用ModifySnapshotAttribute修改一份快照的名称、描述或保留天数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:ModifySnapshotAttributeupdate
*Snapshot
acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

请求参数

名称类型必填描述示例值
SnapshotIdstring

快照 ID。

s-bp199lyny9bb47pa****
SnapshotNamestring

快照的显示名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

为防止和自动快照的名称冲突,不能以 auto 开头。

testSnapshotName
Descriptionstring

快照的描述。长度为 2~256 个英文或中文字符,不能以 http://和 https://开头。

testDescription
DisableInstantAccessboolean

关闭快照极速可用功能。取值范围:

  • true:关闭快照极速可用。
  • false:不关闭快照极速可用。

默认值:false。

说明 该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
false
RetentionDaysinteger

快照保留天数。设置该值时,快照保留时间会从快照创建时间(按照 ISO 8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ)开始计算。取值范围:1~65536。

说明 快照保留时间仅支持延长,不支持缩短快照已有保留时间。
10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400InvalidSnapshotName.MalformedThe specified SnapshotName is wrongly formed.快照名称格式不合法。
400NoAttributeToModifyNo attribute to be modified in this request.没有任何属性被修改。
400InvalidRetentionDays.MalformedThe specified RetentionDays is not valid.指定的保留天数无效。请检查 RetentionDays 参数值是否正确。
400InvalidOperation.DecreaseRetentionDaysUnsupportedThe requested operation to decrease retention days for the snapshot is not supported.不支持缩短快照保留天数。
400InvalidSnapshotId.NotReadyThe specified snapshot has not completed yet.指定的快照未完成。
403InvalidOperation.ResourceManagedByCloudProduct%s云产品托管的安全组不支持修改操作。
404InvalidDescription.MalformedThe specified description is wrongly formed.指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。
404InvalidSnapshotId.NotFoundThe specified SnapshotId does not exist.指定的快照不存在,请您检查快照是否正确。
404InvalidSnapshotDisableInstantAccess.MalformedThe specified DisableInstantAccess is not valid!-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-08OpenAPI 错误码发生变更查看变更详情
2024-10-17OpenAPI 错误码发生变更查看变更详情
2023-10-16OpenAPI 错误码发生变更查看变更详情
2023-09-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情