文档

CreateSnapshotGroup - 创建快照一致性组

更新时间:

调用CreateSnapshotGroup为指定ECS实例中的云盘创建快照一致性组。快照一致性组包含一个或多个云盘对应的快照。

接口说明

您可以设置InstanceId为实例内的指定云盘创建快照一致性组;也可以只使用DiskId.N为同可用区内多台 ECS 实例挂载的多块云盘创建快照一致性组。

说明 DiskId.N不可与ExcludeDiskId.N同时设置。此外,如果设置了InstanceId,则DiskId.N只能设置指定实例内已挂载的云盘,不再支持设置多个跨实例的云盘 ID。

创建快照一致性组时,请注意:

  • 待创建快照的云盘必须处于使用中In_use)或待挂载Available)的状态。

    • 如果云盘处于使用中In_use)的状态,则 ECS 实例状态为运行中Running)或者已停止Stopped)。
    • 如果云盘处于待挂载Available)的状态,则需要保证云盘有过挂载到 ECS 实例的历史操作。从未挂载过 ECS 实例的云盘不支持创建快照。
  • 目前快照一致性组只支持 ESSD 云盘。

  • 单个快照一致性组最多包括 16 块云盘(包括系统盘和数据盘),且总容量不超过 32 TiB。

  • 您自行创建的快照会一直保留,请定期删除不再需要的快照,避免快照容量持续扣费。

  • 开启多重挂载特性的云盘不支持创建快照一致性组。如果实例挂载了开启多重挂载特性的云盘,您需要设置ExcludeDiskId.N参数排除该云盘。

关于快照一致性组的功能、计费等信息,请参见快照一致性组

调试

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

授权信息

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

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

请求参数

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

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
InstanceIdstring

实例 ID。

i-j6ca469urv8ei629****
InstantAccessboolean

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

  • true:开启。
  • false:关闭。

默认值:false。

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

设置快照极速可用的使用时间。单位:天,取值范围:1~65535。

仅当InstantAccess=true时,该参数生效。到期后自动关闭快照极速使用功能。

默认值:空,表示和快照释放时间一致。

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

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

testName
Descriptionstring

描述。长度为 2~256 个字符,不能以http://https://开头。

This is description.
StorageLocationArnstring
说明 该参数暂未开发使用。
null
ExcludeDiskIdarray

实例中不需要创建快照的云盘 ID。指定云盘 ID 后,创建的快照一致性组将不包含该云盘对应的快照。N 的取值范围为 1~16。

默认值:空,表示为实例中的所有云盘创建快照。

说明 该参数不可与DiskId.N同时设置。
string

实例中不需要创建快照的云盘 ID。指定云盘 ID 后,创建的快照一致性组将不包含该云盘对应的快照。N 的取值范围为 1~16。

默认值:空,表示为实例中的所有云盘创建快照。

说明 该参数不可与DiskId.N同时设置。
d-j6cf7l0ewidb78lq****
DiskIdarray

指定创建快照一致性组的云盘 ID。在同可用区内支持跨实例设置多个云盘 ID。N 的取值范围为 1~16,即一个快照一致性组内最多支持设置 16 块总大小不超过 32 TiB 的云盘。

您需要注意:

  • 该参数不可与ExcludeDiskId.N同时设置。
  • 如果您设置了InstanceId,则该参数只能设置指定实例内已挂载的云盘,不再支持设置多个跨实例的云盘 ID。
string

指定创建快照一致性组的云盘 ID。在同可用区内支持跨实例设置多个云盘 ID。N 的取值范围为 1~16,即一个快照一致性组内最多支持设置 16 块总大小不超过 32 TiB 的云盘。

您需要注意:

  • 该参数不可与ExcludeDiskId.N同时设置。
  • 如果您设置了InstanceId,则该参数只能设置指定实例内已挂载的云盘,不再支持设置多个跨实例的云盘 ID。
d-bp1bcpqxahucdrcn****
Tagobject []

标签列表。

Keystring

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

TestKey
Valuestring

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

TestValue
ResourceGroupIdstring

快照一致性组所属的资源组 ID。

rg-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
SnapshotGroupIdstring

快照一致性组 ID。

ssg-j6ciyh3k52qp7ovm****
RequestIdstring

请求 ID。

01ABBD93-1ABB-4D92-B496-1A3D20EC0697

示例

正常返回示例

JSON格式

{
  "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
  "RequestId": "01ABBD93-1ABB-4D92-B496-1A3D20EC0697"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDiskIds.NotInSameZoneThe specified disks are not in the same availability zone.-
400MissingParamter.InstanceIdThe specified InstanceId should not be null.-
400InvalidParam.ExcludeDiskIdsAndDiskIds.ConflictThe use of parameter 'ExcludeDiskIds' and 'DiskIds' at the same time is not supported.-
400InvalidSnapshotName.MalformedThe specified SnapshotName is wrongly formed.快照名称格式不合法。
400IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
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 参数值是否正确。
400DiskCategory.OperationNotSupportedThe special disk is encrypted, not support this operate.-
400InvalidParameter.NameThe specified Name is invalid.指定的 Name 参数无效。
400InvalidParameter.DescriptionThe specified Description is invalid.-
400DiskCategory.OperationNotSupportedThe operation is not supported to the specified disk due to its disk category.由于磁盘种类限制,指定的磁盘不支持该操作。
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.磁盘创建后未被使用,内容没有变化。
403CreateSnapshot.FailedThe process of creating snapshot is failed.创建快照失败。
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 device 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.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 参数值是否正确。
403InvalidOperation.UnauthorizedThe specified operation is unauthorized.-
403InvalidRegion.NotSupportSnapshotInstantAccessRegionThe snapshot InstantAccess is not supported for this region.-
403InvalidCategoryAndInstantAccess.MalformedThe snapshot Category and InstantAccess can't be used together.-
403IncorrectDiskStatus.TooManyCreatingSnapshotsThe specified disk has too many unfinished snapshots.-
403InvalidRegion.NotSupportThe specified region does not support creating snapshot group.-
403UserNotInTheWhiteListThe user is not in the white list of creating snapshot group.-
403InvalidInstance.NoDiskThere is no disk mounted on the instance.-
403NumberExceed.TooManyDisksThe number of all disks in the request exceeds.请求中云盘的数量超过限制。
403CapacityExceed.TooManyDisksThe capacity of all disks in the request exceeds.-
403InvalidDisk.ShareVolume%s-
403InvalidOperation.MultiAttachDiskMulti attach disk does not support this operation.开启多重挂载特性的云盘不支持该操作。
403IncorrectDiskStatus.InvalidThe specified disk status invalid, restart instance and try again.当前磁盘的状态无效,请重启实例后重试。
403InvalidParameter.KMSKeyId.CMKUnauthorizedThe CMK needs to be added ECS tag.CMK 未授权
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.指定的共享块存储不存在,请您检查共享块存储是否正确。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
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-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
2023-08-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
  • 本页导读 (1)
文档反馈