ModifySnapshotAttribute--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

ModifySnapshotAttribute

最近更新时间：2024.05.22 14:09:13首次发布时间：2022.04.28 10:05:44

调用ModifySnapshotAttribute接口修改快照属性，当前仅支持修改快照名称、描述信息和快照保留时间。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	ModifySnapshotAttribute	要执行的操作，取值：ModifySnapshotAttribute
SnapshotId	String	是	snap-bp1s5fnvk4gn2tws0****	需要修改的快照ID。
RetentionDays	Integer	否	30	延长快照保留时间。快照保留时间仅支持延长，不支持缩短。取值范围为N+1~65536，N为快照创建时设置的保留时间。
SnapshotName	String	否	test_modify	快照名称，命名规范如下：长度为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
Description	String	否	testDescription	快照描述信息，长度为0~255个字符。

返回数据

无

请求示例

GET /?Action=ModifySnapshotAttribute&Description=test+modify&SnapshotId=snap-31akybwsxi8rudc6****&SnapshotName=test_modify&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
		"ResponseMetadata": {
				"RequestId": "20220308180931010225243139000DF***",
				"Action": "ModifySnapshotAttribute",
				"Version": "2020-04-01",
				"Service": "storage_ebs",
				"Region": "cn-beijing"
		},
		"Result": {}
}

错误码

HttpCode	错误码	错误信息
400	InvalidSnapshotName	快照名称格式不合法。
400	InvalidDescription	资源描述格式不合法。
400	NotAllowed.PermanentSnapshot	永久保留快照不支持延长快照保留时间。
400	LessThanCurrent.RetentionDays	延长快照保留时间时，设置的值需要大于快照保留时间当前值。
404	SnapshotNotFound	未找到快照。