阿里云服务器CreateSnapshot-[云淘科技_教程]

调用CreateSnapshot为一块云盘创建一份快照。

接口说明

原本地快照更替为快照极速可用功能。参数说明如下：

如果您在2020年12月14日之前使用过本地快照。您可以正常使用参数Category和InstantAccess，但需要注意：
- 参数Category和InstantAccess不能同时传值。
- 参数Category和InstantAccess均不传值时，默认创建普通快照。
如果您在2020年12月14日之前未使用过本地快照。您只能使用参数InstantAccess，不能使用参数Category。

更多信息，请参见12月14日阿里云快照服务升级与新增计费项通知。

以下场景中，您无法为指定的云盘创建快照：

云盘保留的手动快照数达到了256份。
上份快照还未完成创建。
云盘挂载的实例从未启动过。
云盘挂载的实例未处于已停止（Stopped）或者运行中（Running）状态。
查询ECS实例信息时，如果返回数据中包含{"OperationLocks": {"LockReason" : "security"}}，则禁止一切操作。

创建快照时，您需要注意：

如果创建快照还未完成，这份快照无法用于创建自定义镜像（CreateImage）。
如果云盘已挂载到ECS实例上，创建快照期间请勿变更实例状态。
支持对处于已过期（Expired）状态的云盘创建快照。若创建快照时云盘正好达到过期释放时间，云盘被释放的同时也会删除创建中（Creating）的快照。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateSnapshot	系统规定参数。取值：CreateSnapshot。
DiskId	String	是	d-bp1s5fnvk4gn2tws0****	云盘ID。
SnapshotName	String	否	testSnapshotName	快照的显示名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。为防止和自动快照的名称冲突，不能以`auto`开头。
Description	String	否	testDescription	快照的描述。长度为2~256个英文或中文字符，不能以`http://`或`https://`开头。默认值：空。
RetentionDays	Integer	否	30	设置快照的保留时间，单位为天。保留时间到期后快照会被自动释放，取值范围：1~65536。默认值：空，表示快照不会被自动释放。
Category	String	否	Standard	快照类型。取值范围： Standard：普通快照。 Flash：本地快照。说明该参数即将被弃用，为提高兼容性，建议您尽量使用参数`InstantAccess`。该参数和参数`InstantAccess`不能同时传值。更多信息，请参见接口说明。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见如何保证幂等性。
ResourceGroupId	String	否	rg-bp67acfmxazb4p****	快照所在的企业资源组ID。
InstantAccess	Boolean	否	false	是否开启快照极速可用功能。取值范围： true：开启。仅ESSD云盘支持开启该功能。说明启用快照极速可用功能后，即使快照还没有创建完成，您也可以使用快照回滚云盘或者跨可用区创建云盘。无论多大的ESSD云盘，均能够快速确保该快照可用。 false：关闭。即创建普通快照。默认值：false。说明该参数和参数`Category`不能同时传值。更多信息，请参见接口说明。
InstantAccessRetentionDays	Integer	否	1	设置快照极速可用功能的保留时间，保留时间到期后快照将自动释放。该参数在`InstantAccess=true`时生效。单位：天。取值范围：1~65535。默认与参数`RetentionDays`的值一致。
Tag.N.key	String	否	null	快照的标签键。说明为提高兼容性，建议您尽量使用Tag.N.Key参数。
Tag.N.Key	String	否	TestKey	快照的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value	String	否	TestValue	快照的标签值。N的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持128个字符，不能以acs:开头，不能包含http://或者https://。
Tag.N.value	String	否	null	快照的标签值。说明为提高兼容性，建议您尽量使用Tag.N.Value参数。
StorageLocationArn	String	否	null	说明该参数暂未开放使用。

返回数据

名称	类型	示例值	描述
SnapshotId	String	s-bp17441ohwka0yuh****	快照ID。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateSnapshot
&DiskId=d-bp1s5fnvk4gn2tws0****
&SnapshotName=testSnapshotName
&Description=testDescription
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml


        C8B26B44-0189-443E-9816-D951F59623A9
        s-bp17441ohwka0yuh****

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C8B26B44-0189-443E-9816-D951F59623A9",
  "SnapshotId" : "s-bp17441ohwka0yuh****"
}

错误码

HttpCode	错误码	错误信息	描述
400	InvalidParameter.KMSKeyId.NotFound	The specified KMSKeyId does not exist.	指定的参数 KMSKeyId 不存在。
400	InvalidSnapshotName.Malformed	The specified SnapshotName is wrongly formed.	快照名称格式不合法。
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	该资源目前的状态不支持此操作。
400	DiskCategory.OperationNotSupported	The type of the specified disk does not support creating a snapshot.	当前磁盘类型不支持此操作。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	标签中存在重复的键，请保持键的唯一性。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的标签键参数有误。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的标签值参数有误。
400	InvalidRetentionDays.Malformed	The specified RetentionDays is not valid.	指定的保留天数无效。请检查 RetentionDays 参数值是否正确。
400	CreateSnapshot.Failed	The process of creating snapshot is failed.	创建快照失败。
403	Throttling	Request was denied due to user flow control.	当前的操作太过频繁，请稍后重试。
403	IncorrectDiskStatus.CreatingSnapshot	A previous snapshot creation is in process.	当前磁盘有创建中的快照，请您等待创建完成再试。
403	InstanceLockedForSecurity	The disk attached instance is locked due to security.	磁盘挂载的实例因安全原因被锁定。
403	IncorrectDiskStatus.NeverAttached	The specified disk has never been attached to any instance.	可卸载的云磁盘创建后未被挂载，内容没有变化。
403	QuotaExceed.Snapshot	The snapshot quota exceeds.	快照额度超过限制，若要存储新快照，在不影响业务的情况下，请您删除已有的老快照。
403	IncorrectDiskStatus.NeverUsed	The specified disk has never been used after creating.	磁盘创建后未被使用，内容没有变化。
403	DiskInArrears	The specified operation is denied as your disk has expired.	磁盘欠费过期。
403	DiskId.ValueNotSupported	The specified parameter diskid is not supported.	指定的块存储类型不支持此操作。
403	IncorrectDiskStatus	The current disk status does not support this operation.	当前的磁盘不支持此操作，请您确认磁盘处于正常使用状态，是否欠费。
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	账号余额不足，请您先充值再进行该操作。
403	InvalidAccountStatus.SnapshotServiceUnavailable	Snapshot service has not been opened yet.	快照服务未开通，操作无法执行。
403	IncorrectVolumeStatus	The current volume status does not support this operation.	共享块存储状态不支持当前操作。
403	IdempotentParameterMismatch	The specified clientToken is used.	指定的客户令牌已经被使用。
403	IncorrectDiskStatus.Invalid	The specified disk status invalid, restart instance and try again.	当前磁盘的状态无效，请重启实例后重试。
403	IncorrectDiskType.NotSupport	The specified device type is not supported.	指定磁盘存储类型不支持此操作。
403	IncorrectDiskStatus.Transferring	The specified device is transferring, you can retry after the process is finished.	指定磁盘正在迁移中，请在迁移完毕后重试。
403	InvalidParameter.KMSKeyId.CMKUnauthorized	ECS tags must be added to the CMK.	CMK 需要添加 ECS 标签。
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.	加密云盘设置了 KMSKeyId 后，CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。
403	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service have no right to access your KMS.	ECS 服务无权访问您的 KMS。
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	先前的幂等请求仍在处理中，请稍后重试。
403	QuotaExceed.Tags	%s	标签数超过可以配置的最大数量。%s为变量，将根据调用API的实际情况动态返回错误信息。
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	指定的快照类型无效。请检查 Category 参数值是否正确。
403	InvalidAction.Unauthorized	The specified action is not valid.	指定的操作无效。
403	DISK_HAS_CREATING_SNAPSHOT	The operation cannot be performed while a snapshot is being created for the disk.	暂时无法执行操作，该磁盘有正在创建中的快照。
403	HibernationConfigured.InstanceOperationForbidden	The operation is not permitted due to limit of the hibernation configured instance.	不符合开启休眠选项的实例的相关限制，操作不被允许。
403	QuotaExceed.SnapshotQuota	The quota is insufficient, please contact your channel partner to increase the quota.	您当前配额不足，请您可以联系渠道伙伴为您增加额度。
403	InvalidInstantAccessRetentionDays.Malformed	The specified InstantAccessRetentionDays is not valid.	指定的参数InstantAccessRetentionDays格式无效
403	CloudBoxNotSupportSnapshotWithInstantAccess	The specified disk in CloudBox does not support to create a snapshot with InstantAccess.	云盒中的磁盘不支持创建带IA特性的快照。
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	指定的磁盘不存在。请您检查磁盘 ID 是否正确。
404	InvalidDescription.Malformed	The specified description is wrongly formed.	指定的资源描述格式不合法。长度为 2-256 个字符，不能以 http:// 和 https:// 开头。
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定的实例不存在，请您检查实例ID是否正确。
404	InvalidVolumeId.NotFound	The specified volume does not exist.	指定的共享块存储不存在，请您检查共享块存储是否正确。
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	资源组并不在记录中。
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误，请重试。