调用CreateSnapshot接口为云盘创建一个快照。

使用说明

仅极速型SSD、吞吐型SSD云盘支持创建快照。

创建快照前，云盘必须处于“可用”状态或“已挂载”状态。

如果云盘处于“已挂载”状态，那么挂载云盘的实例需处于“运行中”或“已停止”状态。

每个云盘最多可以创建256个手动快照，更多注意事项，请参见创建快照。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateSnapshot

要执行的操作，取值：CreateSnapshot。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

SnapshotName string 必选示例值：testSnapshotName

创建的快照名称。命名规范如下：

长度限制为1~128个字符。

只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。

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

ClientToken string 可选示例值：123e4567-e89b-12d3-a456-42665544****

用以保证请求幂等性。该字符串由您的客户端生成，用以保证不同请求之间的唯一性。ClientToken是一个大小写敏感、不超过64个ASCII字符的字符串。

Description string 可选示例值：testDescription

快照的描述信息，默认为空，长度限制在1 ~ 255字符之间。

Tags.N.Key string[] 可选示例值：Tags.1.Key=tag

快照的标签键。

Tags.N.Key：N表示标签键的序号。取值范围：1～20。

多个标签键之间用&分隔。

Tags.N.Value string[] 可选示例值：Tags.1.Value=test

快照的标签值。

Tags.N.Value：N表示标签值的序号。取值范围：1～20。

多个标签值之间用&分隔。

RetentionDays integer 可选示例值：30

快照保留时间，单位为天，取值说明如下：

空：永久保留快照。

1~65536：指定保存天数。

默认为空，即默认永久保留快照。

说明

快照保留时间从快照创建时刻开始计算。

VolumeId string 必选示例值：vol-bp1s5fnvk4gn2tws0****

待创建快照的云盘ID。

ProjectName string 可选示例值：default

快照所属项目。

说明

快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。

如果您在创建快照时未设置ProjectName，快照会默认加入default项目。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

SnapshotId string 示例值：snap-3tigy72q3u3vj0x2****

快照 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidSnapshotName	The specified snapshot name is invalid.	指定的快照名称格式不合法。
400	AbnormalVolumeStatus	The specified volume status is abnormal.	云盘状态异常。
400	ErrResourceTypeNotFound	resource type not found	未找到资源类型。
400	ErrResourceIdNotFound	resource id not found	未找到资源ID。
400	ErrMaximumResourceIds	too many resource ids	资源ID超出限制。
400	ErrTagServiceUnavailable	tag service unavailable	标签服务不可用。
400	ErrInvalidTagValue	tag value invalid	标签值无效。
400	ErrInvalidTagKey	tag key invalid	标签键无效。
400	ErrTagKeyConflict	tag key conflict	标签键冲突。
400	ErrInvalidTagNum	too many tags	标签数量超出限制。
400	ErrTagNotFound	tag not found in request	请求中未找到标签。
400	InvalidDescription	The specified description is invalid.	指定的资源描述格式不合法。
400	InvalidRequest	The operation is not permitted due to the request is invalid.	无效的请求。
400	ErrorAccountIsOverdue	Account is in arrears, and some snapshot features are unavailable.	账号已欠费，快照部分功能不可用。
400	VolumeInCreatingSnapshot	The operation is not permitted due to the volume is creating a snapshot.	指定的云盘有正在创建的快照。
400	VolumeInCreatingAutoSnapshot	The operation is not permitted due to the volume is creating an auto snapshot.	指定的云盘有正在创建的自动快照。
400	VolumeTypeNotSupportSnapshot	Snapshots are not supported for this volume type.	该云盘类型不支持快照。
403	SnapshotJobQuotaExceed	The number of snapshot task exceeds the limit.	快照任务数量超出限制。
403	InstantAccessSnapshotQuotaExceed	The number of instant access snapshot exceeds the limit.	极速可用快照数量超出限制。
403	SnapshotQuotaExceed	The number of snapshot exceeds the limit.	快照数量超出限制。
404	VolumeNotFound	The specified volume does not exist.	云盘不存在。
404	ErrResourceNotFound	resource not found	找不到资源。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

云服务器