通过云盘克隆可以快速在同一可用区复制出一块与源盘相同数据的新云盘。克隆出的新云盘支持自定义容量、类型和加密属性,挂载至实例后,可实现业务数据的快速复制或服务的横向扩展。
接口说明
云盘克隆功能本身不收费,但克隆生成的新云盘将按照块存储计费规则收取费用。云盘的计费项因类型而异,包括云盘容量费用、预配置性能费用及性能突发费用。除性能突发费用在突发后计费外,其他费用在创建后即开始计费,无论是否挂载至实例。
使用方式
该接口为异步接口,调用成功后请使用 taskGroupId 并调用 DescribeTasks 接口获取执行结果
功能特性
- 克隆仅支持从 ESSD 全系云盘(cloud_essd、cloud_auto、cloud_essd_entry、cloud_regional_disk_auto)直接克隆
新云盘,克隆出的新云盘仅支持 ESSD 全系云盘类型非同城冗余云盘仅能克隆至非同城冗余类型,同城冗余云盘仅能克隆至同城冗余云盘
本地盘、弹性临时盘既不支持克隆,也不支持被克隆
克隆可以指定
新云盘类型以及性能等级克隆可以指定
新云盘容量,但新云盘容量需要大于等于源云盘克隆可以配置
新云盘的预置性能、性能突发,前提是目标磁盘类型需要支持预置、性能突发克隆可以为
新云盘指定加密以及更换加密密钥。若源云盘为加密盘,无法克隆出非加密云盘,但可以更换加密密钥克隆可以使用包年包月的云盘作为
源云盘,即使包年包月的云盘到期,也可以作为源云盘克隆出的
新云盘不支持重新初始化克隆不支持存储集、专属存储集群,但是其中的盘可以作为
源云盘,克隆出的盘将不会在存储集、专属存储集群内源云盘状态限制源云盘状态为“使用中”,且对应实例状态为“运行中”或者“已关机”源云盘状态为“待挂载”,且云盘曾经被挂载过变配期间的磁盘不支持作为
源云盘扩容期间的磁盘不支持作为
源云盘
实例休眠场景不支持云盘克隆,即如果盘在休眠实例上,那么不允许作为
源云盘
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:CloneDisks |
create |
*Disk
*Disk
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| DryRun |
string |
否 |
是否只预检此次请求。取值范围:
|
true |
| ClientToken |
string |
否 |
保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 |
123e4567-e89b-12d3-a456-426655440000 |
| Tag |
array<object> |
否 |
磁盘的标签信息列表。 |
|
|
object |
否 |
磁盘的标签信息列表。 |
||
| Key |
string |
否 |
磁盘的标签键。N 的取值范围:1~20。一旦传入 Tag.N.Key 值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。 |
TestKey |
| Value |
string |
否 |
磁盘的标签值。N 的取值范围:1~20。一旦传入 Tag.N.Value 值,可以为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。 |
TestValue |
| ResourceGroupId |
string |
否 |
磁盘所在的企业资源组 ID。 |
rg-bp199lyny9b3**** |
| SourceDiskId |
string |
是 |
源磁盘 ID |
d-bp1d6tsvznfghy7y**** |
| DiskName |
string |
否 |
磁盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文等),ASCII 数字(0-9)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。必须以 Unicode 中 letter 分类下的字符开头。 默认值:空。 |
MyDiskName |
| DiskCategory |
string |
是 |
新磁盘的磁盘类型。取值范围:
说明
云盘克隆的磁盘类型限制
|
cloud_essd |
| PerformanceLevel |
string |
否 |
创建一块 ESSD 云盘时,设置云盘的性能等级。取值范围:
说明
如果 DiskCategory = cloud_essd,则 PerformanceLevel 是必传值 有关如何选择 ESSD 性能等级,请参见 ESSD 云盘。 |
PL1 |
| Size |
integer |
是 |
新磁盘容量大小。单位:GiB。您必须为该参数传入参数值。取值范围:
|
60 |
| MultiAttach |
string |
是 |
新磁盘是否开启多重挂载特性。取值范围:
|
Disabled |
| ProvisionedIops |
integer |
否 |
ESSD AutoPL 云盘(单盘)预配置性能的读写 IOPS。可能值:
基准性能=max{min{1,800+50*容量,50,000}, 3,000}。 说明
当 DiskCategory = cloud_auto 时才支持设置该参数。更多信息,请参见 ESSD AutoPL 云盘。 |
10 |
| BurstingEnabled |
boolean |
否 |
新磁盘是否开启 Burst(性能突发)。取值范围:
说明
当 DiskCategory = cloud_auto 时才支持设置该参数。更多信息,请参见 ESSD AutoPL 云盘。 |
true |
| Encrypted |
boolean |
否 |
新磁盘是否是加密云盘。取值范围:
默认值:false。 |
false |
| KmsKeyId |
string |
否 |
新磁盘使用的 KMS 密钥 ID。 |
key-szz67b2f696f4wh9yeg5d |
| Arn |
array<object> |
否 |
说明
该参数暂未开放使用 |
|
|
object |
否 |
说明
该参数暂未开放使用 |
||
| RoleType |
string |
否 |
说明
该参数暂未开放使用 |
null |
| Rolearn |
string |
否 |
说明
该参数暂未开放使用 |
null |
| AssumeRoleFor |
string |
否 |
说明
该参数暂未开放使用 |
null |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| TaskGroupId |
string |
云盘克隆的任务组 ID,您可以通过 DescribeTasks 查询任务执行结果 |
g-2ze2op2grqpclwu7**** |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"TaskGroupId": "g-2ze2op2grqpclwu7****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidDiskCategory.SourceDiskCategoryNotSupport | The specified target disk category %s does not support cloning from origin disk category %s. | |
| 400 | InvalidDisk.NeverAttached | The specified disk %s has been never attached to any instance. | |
| 400 | InvalidStatus.SourceDiskStatusViolation | The specified disk %s has an invalid status. The expected status is Available or In_use; but the current status is %s. | |
| 400 | InvalidDiskCategory.ValueNotSupported | The specified parameter "DiskCategory" is not valid. | 指定的参数云盘类型DiskCategory无效。 |
| 400 | InvalidDiskName.ValueNotSupported | The specified parameter "DiskName" is not valid. | |
| 400 | InvalidPerformanceLevel.ValueNotSupported | The specified parameter "PerformanceLevel" is not valid. | |
| 400 | InvalidMultiAttach.ValueNotSupported | The specified parameter "MultiAttach" is not valid. | |
| 400 | InvalidBurstingEnabled.DiskCategoryNotSupported | The specified disk category does not support bursting enabled. | |
| 400 | InvalidProvisionedIops.DiskCategoryNotSupported | The specified disk category does not support provisioned IOPS. | |
| 400 | InvalidProvisionedIops.LimitExceed | The provisioned IOPS exceeds the permitted range for the specified disk category. | |
| 400 | InvalidSize.MustGreaterThanSourceDisk | The specified size %s(GB) must greater than source disk size %s(GB). | |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | 通过“DryRun”校验,您的请求已通过验证。 |
| 400 | InvalidSourceDisk.Lazyloading | The specified source disk %s is lazyloading. | |
| 400 | InvalidOperation.DiskCloneExceedsConcurrencyLimit | The source disk %s has reached the maximum number (1) of concurrent clone operations. In-progress cloned disks: %s. Please wait a moment and try again later. | |
| 400 | InvalidParameter.Arns | The specified Arns is not valid. | 该Arns参数无效,请检查后重新传递。 |
| 401 | InvalidOperation.UserNotInWhiteList | The specified user %s is not in the CloneDisks whitelist. | |
| 404 | InvalidRegionId.NotFound | The specified region does not exist. | 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。 |
| 404 | InvalidSourceDiskId.NotFound | The specified source disk does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。