为一块云盘创建一份快照。
接口说明
原本地快照更替为快照极速可用能力。参数说明如下:
- 如果您在 2020 年 12 月 14 日之前使用过本地快照,您可以正常使用参数
Category
。 - 如果您在 2020 年 12 月 14 日之前未使用过本地快照,无需额外进行配置,ESSD 系列云盘(ESSD、ESSD AutoPL、ESSD Entry 和 ESSD 同城冗余)新建的快照将默认为创建后极速可用,且同时支持手动快照和自动快照。API 接口中的“InstantAccess”、“InstantAccessRetentionDays”、“DisableInstantAccess”三个极速可用功能相关参数不再生效,“DescribeSnapshots”、“DescribeSnapshotGroups”这两个 API 接口将新增出参 Available 来描述快照可用的状态。
前提条件:
-
已开通快照。具体操作,请参见开通快照。
-
云盘必须处于使用中或待挂载状态。不同状态下的注意事项如下:
创建快照时,您需要注意:
-
创建快照应避开业务高峰期。创建快照时,云盘 I/O 性能降低 10%以内,读写性能出现短暂瞬间变慢。
-
如果创建快照还未完成,这份快照无法用于创建自定义镜像( CreateImage )。
-
创建快照期间,操作云盘产生的增量数据不会备份到快照中。
-
如果云盘已挂载到 ECS 实例上,创建快照期间请勿变更实例状态,如停止或重启 ECS 实例,否则会导致快照创建失败。
-
正在创建快照的云盘不支持扩容。请您等待快照创建完成后,再开始执行扩容操作。
-
支持对处于已过期(
Expired
)状态的云盘创建快照。若创建快照时云盘正好达到过期释放时间,云盘被释放的同时也会删除创建中(Creating
)的快照。 -
创建快照后,系统根据快照容量大小,按每个地域单独结算费用。更多信息,请参见快照计费
-
以下场景中,您无法为指定的云盘创建快照:
-
云盘保留的手动快照数达到了 256 份。
-
上份快照还未完成创建。
-
查询 ECS 实例信息时,如果返回数据中包含
{"OperationLocks": {"LockReason" : "security"}}
,则禁止一切操作。
-
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:CreateSnapshot | create | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId} *Snapshot acs:ecs:{#regionId}:{#accountId}:snapshot/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DiskId | string | 是 | 云盘 ID。 | d-bp1s5fnvk4gn2tws0**** |
SnapshotName | string | 否 | 快照的名称。长度为 2~128 个字符,必须以大小写字母或中文开头,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文等),ASCII 数字(0-9)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。 说明
不能以 http://和 https:// 开头。为防止和自动快照的名称冲突,不能以 auto 开头。
| testSnapshotName |
Description | string | 否 | 快照的描述。长度为 2~256 个英文或中文字符,不能以 默认值:空。 | testDescription |
RetentionDays | integer | 否 | 设置快照的保留时间,单位为天。取值范围:1~65536。保留时间到期后快照会被自动释放。 默认值:空,表示快照不会被自动释放。 | 30 |
Category | string | 否 | Standard | |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
ResourceGroupId | string | 否 | 快照所在的企业资源组 ID。 | rg-bp67acfmxazb4p**** |
InstantAccess | boolean | 否 | 是否开启快照极速可用功能。取值范围:
默认值:false。 说明
该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
| false |
InstantAccessRetentionDays | integer | 否 | 设置快照极速可用功能的保留时间,保留时间到期后快照将自动释放。该参数在 默认与参数 说明
该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
| 1 |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
key | string | 否 | 快照的标签键。 说明
为提高兼容性,建议您尽量使用 Tag.N.Key 参数。
| null |
Key | string | 否 | 快照的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。 | TestKey |
Value | string | 否 | 快照的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。 | TestValue |
value | string | 否 | 快照的标签值。 说明
为提高兼容性,建议您尽量使用 Tag.N.Value 参数。
| null |
StorageLocationArn | string | 否 | 说明
该参数暂未开放使用。
| null |
返回参数
示例
正常返回示例
JSON
格式
{
"SnapshotId": "s-bp17441ohwka0yuh****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | InvalidRegion.NotSupportSnapshotInstantAccessRegion | The snapshot InstantAccess is not supported for this region. | - |
403 | InvalidCategoryAndInstantAccess.Malformed | The snapshot Category and InstantAccess can't be used together. | - |
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特性的快照。 |
403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance to order postpaid product. | 使用按量付费产品,您的账户余额不得少于100元,请充值后再操作。 |
403 | InvalidOperation.UnfinishedEncryptedSnapshotCopy | This disk has unfinished encrypted copy snapshots in the target region. | 云盘存在未完成的加密快照拷贝任务。 |
403 | QuotaExceed.ConcurrentSnapshotQuota | The number of snapshots being created for the disk %s has exceeded the concurrent quota (%s). Please wait for the previous snapshots to complete before trying again. | 该磁盘正在创建的快照数量已超过并发配额,请等待之前的快照完成后再重试。 |
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. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-22 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-10-08 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-01 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-30 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-22 | OpenAPI 错误码发生变更 | 查看变更详情 |