文档

CreateSnapshot - 创建一份快照

更新时间:

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

接口说明

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

  • 如果您在 2020 年 12 月 14 日之前使用过本地快照,您可以正常使用参数 Category。
  • 如果您在 2020 年 12 月 14 日之前未使用过本地快照,无需额外进行配置,ESSD PL0/1/2/3 及 ESSD AutoPL 系列云盘新建的快照将默认为创建后极速可用,且同时支持手动快照和自动快照。API 接口中的“InstantAccess”、“InstantAccessRetentionDays”、“DisableInstantAccess”三个极速可用功能相关参数不再生效,“DescribeSnapshots”、“DescribeSnapshotGroups”这两个 API 接口将新增出参 Available 来描述快照可用的状态。

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

  • 云盘保留的手动快照数达到了 256 份。

  • 上份快照还未完成创建。

  • 云盘挂载的实例从未启动过。

  • 云盘挂载的实例未处于已停止Stopped)或者运行中Running)状态。

  • 查询 ECS 实例信息时,如果返回数据中包含{"OperationLocks": {"LockReason" : "security"}},则禁止一切操作。

创建快照时,您需要注意:

  • 如果创建快照还未完成,这份快照无法用于创建自定义镜像( CreateImage )。

  • 如果云盘已挂载到 ECS 实例上,创建快照期间请勿变更实例状态。

  • 支持对处于已过期Expired)状态的云盘创建快照。若创建快照时云盘正好达到过期释放时间,云盘被释放的同时也会删除创建中Creating)的快照。

调试

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

授权信息

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

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

请求参数

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

云盘 ID。

d-bp1s5fnvk4gn2tws0****
SnapshotNamestring

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

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

testSnapshotName
Descriptionstring

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

默认值:空。

testDescription
RetentionDaysinteger

设置快照的保留时间,单位为天。保留时间到期后快照会被自动释放,取值范围:1~65536。

默认值:空,表示快照不会被自动释放。

30
Categorystring

快照类型。取值范围:

  • Standard:普通快照。
  • Flash:本地快照。
说明 该参数即将被弃用。ESSD 云盘普通快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
Standard
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
ResourceGroupIdstring

快照所在的企业资源组 ID。

rg-bp67acfmxazb4p****
InstantAccessboolean

是否开启快照极速可用功能。取值范围:

  • true:开启。仅 ESSD 云盘支持开启该功能。
  • false:关闭。即创建普通快照。

默认值:false。

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

设置快照极速可用功能的保留时间,保留时间到期后快照将自动释放。该参数在InstantAccess=true时生效。单位:天。取值范围:1~65535。

默认与参数RetentionDays的值一致。

说明 该参数已弃用。ESSD 云盘普通快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
1
Tagarray<object>

标签列表。

object

标签列表。

keystring

快照的标签键。

说明 为提高兼容性,建议您尽量使用 Tag.N.Key 参数。
null
Keystring

快照的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

TestKey
Valuestring

快照的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。

TestValue
valuestring

快照的标签值。

说明 为提高兼容性,建议您尽量使用 Tag.N.Value 参数。
null
StorageLocationArnstring
说明 该参数暂未开放使用。
null

返回参数

名称类型描述示例值
object
SnapshotIdstring

快照 ID。

s-bp17441ohwka0yuh****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "SnapshotId": "s-bp17441ohwka0yuh****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-08-01OpenAPI 错误码发生变更查看变更详情
2023-03-30OpenAPI 错误码发生变更查看变更详情
2023-03-22OpenAPI 错误码发生变更查看变更详情