接口功能介绍

支持创建一块按量付费或包年包月云硬盘

接口约束

当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。

URI

POST /v4/ecs/volume_create

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
clientToken	否	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时	cbe3840c-bda4-4102-b68f-98c9d7190d69
regionID	是	String	资源池ID，您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表	41f64827f25f468595ffa3a5deb5d15d
multiAttach	否	Boolean	是否支持多云主机挂载，默认false	false
isEncrypt	否	Boolean	是否加密盘，取值范围： true表示加盟， false表示未加密	false
kmsUUID	否	String	加密盘的ID，如果是加密盘，需要提供kms的uuid	bbbbbbbb-cbe3840c-bda4-4102-b68f-98c9d7190d69
projectID	否	String	企业项目ID,默认值为0	aaaaaaaa-bda4-4102-b68f-98c9d7190d69
diskMode	否	String	云硬盘属性，取值范围: [FCSAN、ISCSI、VBD]，默认值为VBD	VBD
diskType	是	String	云硬盘类型，取值范围： SATA：普通IO SAS：高IO SSD：超高IO SSD-genric：通用型SSD FAST-SSD：极速型SSD	SSD
name	否	String	云硬盘命名，单账户单资源池下，命名需唯一	mydisk-000
diskSize	是	Integer	云硬盘大小，单位GB	10
onDemand	否	Boolean	是否按需下单。默认为true	true
cycleType	否	String	订购周期类型，取值范围: MONTH：表示按月， YEAR：表示按年。onDemand为false时，必须指定。	YEAR
cycleCount	否	Integer	包周期数。onDemand为false时必须指定。周期最大长度不能超过5年	2
azName	否	String	可用区名称。您可以调用资源池可用区查询，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default),多可用区资源池下，必须指定可用区	az1
imageID	否	String	镜像ID，您可以调用[imageID]查看最新的天翼云具体资源池的镜像列表，如果用镜像创建，只支持数据盘的私有镜像，所创建的数据盘的所在地域要与镜像源一致，容量不可小于镜像对应的磁盘容量，不支持批量创建操作，从镜像创建的数据盘不支持加密、iSCSI和FCSAN高级配置

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为处理中或失败)	800
message	String	失败时的错误描述，一般为英文描述	Param is null
description	String	失败时的错误描述，一般为中文描述	请求为空
returnObj	Object	返回参数		returnObj
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明.	Ebs.RegionInfo.AccessFailed
errorDetail	Object	错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。其他订单侧(bss)的错误，以ebs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息		errorDetail

表 returnObj

参数	参数类型	说明	示例	下级对象
masterOrderID	String	主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态	107e901c449611ed8b6a0242ac110002
masterOrderNO	String	订单号	20221009163836430197
masterResourceID	String	主资源ID。云硬盘场景下，无需关心	34c7cc05a52b48eda0a84e34a82b346b
masterResourceStatus	String	主资源状态。只有主订单资源会返回。unknown/failed/ starting
regionID	String	资源池ID	41f64827f25f468595ffa3a5deb5d15d
resources	Object	资源明细列表		resources

表 resources

参数	参数类型	说明	示例
resourceID	String	单项资源的变配、续订、退订等需要该资源项的ID。比如某个云主机资源作为主资源，对其挂载	磁盘操作时，需要磁盘资源项的资源ID
orderID	String	无需关心	c0af4aeff6bc40f5a6e2aa995bb3f529
startTime	Integer	启动时刻，epoch时戳，毫秒精度	1689819850000
createTime	Integer	创建时刻，epoch时戳，毫秒精度	1689819836000
updateTime	Integer	更新时刻，epoch时戳，毫秒精度	1689819855000
status	Integer	资源状态，无需关心。	2
isMaster	Boolean	是否是主资源项	true
itemValue	Integer	资源规格，磁盘资源为磁盘大小GB	10
resourceUUID	String	资源UUID，结合regionID一起使用	504ca977285a42e4a22526c825df24fb
resourceType	String	资源类型，云硬盘为EBS	EBS
masterResourceID	String	主资源ID。云硬盘场景下，无需关心。	504ca977285a42e4a22526c825df24fb
name	String	云硬盘名称	test-volume

表 errorDetail

参数	参数类型	说明	示例
masterOrderID	String	主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态	107e901c449611ed8b6a0242ac110002
bssErrCode	String	bss错误明细码，包含于bss格式化JSON错误信息中
bssErrMs	String	bss错误信息，包含于bss格式化JSON错误信息中
bssOrigErr	String	无法明确解码bss错误信息时，原样透出的bss错误信息
bssErrPrefixHint	String	bss格式化JSON错误信息的前置提示信息

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
	"clientToken": "cbe3840c-bda4-4102-b68f-98c9d7190d69",
	"regionID": "41f64827f25f468595ffa3a5deb5d15d",
	"multiAttach": false,
	"isEncrypt": false,
	"kmsUUID": "",
	"projectID": "0",
	"diskMode": "VBD",
	"diskType": "SATA",
	"name": "mydisk-0001",
	"diskSize": 200,
	"onDemand": false,
	"cycleType": "MONTH",
	"cycleCount": 2,
	"azName": ""
}

响应示例

{
	"returnObj": {
		"masterResourceStatus": "started",
		"regionID": "bb9fdb42056f11eda1610242ac110002",
		"masterOrderID": "75cc2a4c26a411eea97b0242ac110002",
		"masterResourceID": "504ca977285a42e4a22526c825df24fb",
		"masterOrderNO": null,
		"resources": [{
			"orderID": "c0af4aeff6bc40f5a6e2aa995bb3f529",
			"status": 2,
			"isMaster": true,
			"name": "test-volume",
			"resourceType": "EBS",
			"resourceID": "504ca977285a42e4a22526c825df24fb",
			"masterOrderID": "75cc2a4c26a411eea97b0242ac110002",
			"updateTime": 1689819855000,
			"masterResourceID": "504ca977285a42e4a22526c825df24fb",
			"itemValue": 10,
			"startTime": 1689819850000,
			"resourceUUID": "908e83c1-1835-4b42-8206-b2353d75852a",
			"createTime": 1689819836000
		}]
	},
	"details": "",
	"message": "success",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码