CreateVolume--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

CreateVolume

最近更新时间：2024.11.01 18:49:25首次发布时间：2021.11.17 14:15:55

调用CreateVolume接口创建云盘。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	CreateVolume	要执行的操作，取值：CreateVolume。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
VolumeName	String	是	test-volume	云盘显示名称。命名规则如下：首字符仅支持中文、字母或下划线（_）。可包含中文、字母、数字、下划线（_）或中划线（-）。长度限制在1~128字符之间。
VolumeType	String	是	ESSD_PL0	云盘类型，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格。 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。 TSSD_TL0: 吞吐型SSD云盘。说明关于云盘规格的详细说明，请参见云盘规格和云盘规格-吞吐型SSD云盘。
Kind	String	否	data	云盘属性，data表示数据盘。默认值为data。说明仅支持创建数据盘。
Size	Int	是	40	数据盘容量大小，单位为GiB。不同类型的数据盘容量范围如下： ESSD_PL0：10~32,768 GiB ESSD_FlexPL：10~32,768 GiB TSSD_TL0：40~32,768 GiB
SnapshotId	String	否	snap-ass6qd6tmm8gjme1****	快照ID。说明使用快照创建云盘时，需要设置该参数。
InstanceId	String	否	i-ybliv8vfkzlbzah6****	创建云盘的同时挂载的ECS实例ID。注意创建包年包月云盘时，该参数为必选参数，且挂载的ECS实例必须为包年包月实例。包年包月云盘的地域和可用区需要与所挂载实例相同。当您同时设置了`InstanceId`和`ZoneId`参数后，如果实例所在的地域与`ZoneId`指定的地域不一致，则请求会失败。
ZoneId	String	否	cn-beijing-a	可用区ID。注意如果您没有设置`InstanceId`，则`ZoneId`为必填参数。当您同时设置了`InstanceId`和`ZoneId`参数后，如果实例所在的地域与`ZoneId`指定的地域不一致，则请求会失败。
Description	String	否	用于测试的云盘	云盘的描述信息，默认为空，长度限制在1 ~ 255字符之间。
VolumeChargeType	String	否	PostPaid	付费方式，默认按量计费，取值说明如下： PostPaid：按量计费 PrePaid：包年包月
ExtraPerformanceTypeId	String	是	IOPS	额外性能的类型，不同的云盘，取值不同，说明如下： ESSD FlexPL数据盘的额外性能取值如下： Balance：均衡型额外性能。 IOPS：IOPS型额外性能。 Throughput：吞吐量型额外性能。说明关于ESSD FlexPL数据盘额外性能的详细介绍，请参见云盘额外性能。 TSSD_TL0数据盘仅支持取值`Throughput`，表示为TSSD_TL0云盘配置额外吞吐量，详细介绍，请参见云盘规格-吞吐型SSD云盘说明仅500 GiB及以上的ESSD FlexPL数据盘，才支持配置额外性能。仅100 GiB及以上的TSSD_TL0数据盘，才支持配置额外性能。
ExtraPerformanceIOPS	Integer	否	100	额外IOPS性能大小，单位为次/秒，各个类型的额外性能取值范围如下： IOPS型额外性能: 0~50000 Balance型额外性能: 0~50000
ExtraPerformanceThroughputMB	Integer	否	100	额外吞吐性能大小，单位为MB/s。说明 ESSD FlexPL数据盘的额外吞吐性能的取值范围为0~650。不同容量的吞吐型SSD云盘，可购买的额外吞吐量不同。您可以调用DescribeMaxExtraPerformanceCanPurchase接口查询当前容量云盘可购买的额外吞吐性能上限，详细介绍，请参见DescribeMaxExtraPerformanceCanPurchase。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	用以保证请求幂等性。该字符串由您的客户端生成，用以保证不同请求之间的唯一性。ClientToken是一个大小写敏感、不超过64个ASCII字符的字符串。
ProjectName	String	否	default	云盘所要加入的Project（项目）名称。说明如果您在创建云盘时未设置`ProjectName`，则云盘默认会加入default项目。
Tags.N.Key	String	否	Tags.1.Key=tag	需要创建的标签键。 Tags.N.Key：`N`表示标签键的序号。取值范围：1～20。多个标签键之间用`&`分隔。命名规则如下：不能以任何大小写形式的`volc:`或`sys:`开头，`volc:`或`sys:`开头为系统预留标签键，禁止创建。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度限制在1～128个字符之间。
Tags.N.Value	String	否	Tags.1.Value=test	标签的标签值。 Tags.N.Value：`N`表示标签值的序号。取值范围：1～20。多个标签值之间用`&`分隔。命名规则如下：只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。允许为空，长度限制在0～256个字符之间。

返回数据

名称	类型	示例值	说明
VolumeId	String	vol-3tigy72q3u3vj0x2****	创建的云盘的ID。

请求示例

GET /?Action=CreateVolume&Version=2020-04-01&ZoneId=cn-beijing-a&VolumeName=test&VolumeType=ESSD_PL0&Kind=data&Size=40&Description=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210702183508010225243153072A****",
        "Action": "CreateVolume",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "VolumeId": "vol-3tj23cr2y23vj0wt****"
    }
}

错误码

HttpCode	错误码	错误信息
400	InvalidVolumeSize	云盘大小不合法
400	InvalidVolumeType	非法的云盘类型
400	InvalidVolumeName	非法的云盘名称
400	InvalidVolumeKind	云盘属性不合法
400	MissingZoneID	缺少可用区ID
400	MissingVolumeName	缺少云盘名称
400	MissingVolumeType	未指定云盘类型
400	InvalidVolumeNameLen	云盘名称长度不合法
400	InvalidVolumeNameFormat	云盘名称格式不合法
400	NoAvailableVolumePool	可用区中无支持该类型的存储池
400	InvalidDescriptionLen	云盘描述长度不合法
400	InvalidDescriptionFormat	描述格式不合法
400	InvalidArgument	BalanceNotEnough:用户余额不足
400	NoAvailableVolumePool	资源不足
400	FailedPrecondiation	操作失败，request id: [xxxxx]，请提工单解决
400	ChargeTypeNotSupport	计费方式暂不支持
400	ErrorCreateIdempotencyFailed	创建幂等记录失败
400	ErrorUpdtaeIdempotencyFailed	更新幂等记录失败
400	ErrorIdempotencyStatusFailed	幂等请求已经失败
400	ErrorIdempotencyStatusTimeout	幂等请求重试超时
400	ErrorInvalidIdempotencyParam	幂等请求参数冲突
400	ErrorInvalidIdempotencyAccount	幂等请求账号冲突
400	ErrorInvalidIdempotencyAction	幂等请求Action冲突
400	ErrorInvalidIdempotencyBusy	幂等请求并发过多，稍后重试
400	ErrorLoadIdempotencyFailed	幂等请求回放加载失败
400	InvalidProjectName	指定的项目名不合法。