接口功能介绍

支持创建一块按量付费或包年包月云硬盘
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
计费模式：确认开通云硬盘的计费模式，详细查看计费模式
地域选择：选择创建云主机的资源池，详细查看地域和可用区
准备工作：
成本估算：了解云硬盘的云硬盘计费说明
用户配额：确认个人在不同资源池下资源配额，可以通过用户配额查询接口进行查询
异步接口：该接口为异步接口，下单成功不代表云硬盘创建成功
企业项目：保证资源隔离

接口约束

1. 用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单
2. 用户云硬盘配额未满

URI

POST /v4/ecs/volume/create

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
diskMode	是	String	磁盘模式，取值范围： FCSAN（光纤通道协议的SAN网络）， ISCSI（小型计算机系统接口）， VBD（虚拟块存储设备）您可以查看磁盘模式及使用方法了解相关内容。注：默认值为VBD；XSSD类型盘不支持ISCSI和FCSAN	VBD
diskType	是	String	云硬盘类型，取值范围： SATA（普通IO）， SAS（高IO）， SSD（超高IO）， SSD-genric（通用型SSD）， FAST-SSD（极速型SSD）您可以查看磁盘类型及性能介绍磁盘类型相关信息注：极速SSD类型盘（FAST-SSD）不支持ISCSI磁盘模式;只有高IO类型（SAS）支持FCSAN磁盘模式；XSSD类型盘不支持多挂载、加密、ISCSI和FCSAN磁盘模式	SSD
diskName	是	String	云硬盘命名，单账户单资源池下，命名需唯一	mydisk-000
diskSize	是	Integer	云硬盘大小，单位GB，取值范围：[10, 32768]	20
clientToken	否	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时	cbe3840c-bda4-4102-b68f-98c9d7190d69
azName	否	String	可用区名称，您可以查看地域和可用区来了解可用区获取：查资源池可用区查询注：查询结果中zoneList内返回存在可用区名称（即多可用区，本字段必填），若查询结果中zoneList为空（即为单可用区，本字段不可填写）	cn-huadong1-jsnj1A-public-ctcloud
multiAttach	否	Boolean	是否支持多云主机挂载，注：默认值false；XSSD类型盘不支持多挂载	false
onDemand	否	Boolean	是否按需下单，注：默认值true	false
cycleType	否	String	订购周期类型，取值范围： MONTH（表示按月）， YEAR（表示按年）。注：onDemand为false时，必须指定。	MONTH
cycleCount	否	Integer	包周期数。注：onDemand为false时必须指定；周期最大长度不能超过5年	1
isEncrypt	否	Boolean	是否加密盘，取值范围： true表示加密， false表示未加密。注：默认值false；XSSD类型盘不支持加密
kmsUUID	否	String	天翼云自研密钥管理（KMS，Key Management Service）的ID，如果是加密盘（参数isEncrypt为true时），需要提供KMS的uuid，您可以查看支持云硬盘加密功能了解云硬盘加密功能
projectID	否	String	企业项目ID，默认值为"0"，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目	0
imageID	否	String	镜像ID，如果用镜像创建，只支持数据盘的私有镜像，所创建的数据盘的所在地域要与镜像源一致，容量不可小于镜像对应的磁盘容量，不支持批量创建操作，从镜像创建的数据盘不支持加密、ISCSI和FCSAN高级配置

响应参数

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

表 errorDetail

参数	参数类型	说明	示例
bssErrCode	String	bss错误明细码，包含于bss格式化JSON错误信息中	code_foo
bssErrMs	String	bss错误信息，包含于bss格式化JSON错误信息中	error_foo
bssOrigErr	String	无法明确解码bss错误信息时，原样透出的bss错误信息	unknow_error
bssErrPrefixHint	String	bss格式化JSON错误信息的前置提示信息	error_bar

表 returnObj

参数	参数类型	说明	示例	下级对象
masterOrderID	String	主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态	107e901c449611ed8b6a0242ac110002
masterOrderNO	String	订单号	20221009163836430197
masterResourceID	String	主资源ID。云硬盘场景下，无需关心	34c7cc05a52b48eda0a84e34a82b346b
masterResourceStatus	String	主资源状态。只有主订单资源会返回。unknown/failed/ starting	starting
regionID	String	资源池ID	bb9fdb42056f11eda1610242ac110002
resources	Array of Objects	资源明细列表，注：订单未完成情况下不返回；待订单完成后使用创建时同样的clientToken（24小时后失效）进行查询，则返回该部分内容		resources

表 resources

参数	参数类型	说明	示例
diskID	String	资源底层ID，即磁盘ID	0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
orderID	String	无需关心	c0af4aeff6bc40f5a6e2aa995bb3f529
startTime	Integer	启动时刻，epoch时戳，毫秒精度	1689819850000
createTime	Integer	创建时刻，epoch时戳，毫秒精度	1689819836000
updateTime	Integer	更新时刻，epoch时戳，毫秒精度	1689819855000
status	Integer	资源状态，无需关心。参考masterResourceStatus	2
isMaster	Boolean	是否是主资源项	true
itemValue	Integer	资源规格，这里指磁盘大小，单位GB	10
resourceType	String	资源类型，云硬盘为EBS	EBS
diskName	String	云硬盘名称	test-volume

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

示例1：创建一个以月为周期类型的云硬盘
{
	"clientToken": "20230211ebsspec7",
	"diskName":"ebs-newspec-test0211v7",
	"diskMode":"VBD",
	"diskType":"SATA",
	"diskSize":10,
	"regionID":"bb9fdb42056f11eda1610242ac110002",
	"azName":"cn-huadong1-jsnj1A-public-ctcloud",
	"onDemand": false,
	"cycleType":"month",
	"cycleCount":1
}

示例2：创建一个按量付费的云硬盘
{
	"clientToken": "20230211ebsspec7",
	"diskName":"ebs-newspec-test0211v7",
	"diskMode":"VBD",
	"diskType":"SATA",
	"diskSize":10,
	"regionID":"bb9fdb42056f11eda1610242ac110002",
	"azName":"cn-huadong1-jsnj1A-public-ctcloud",
	"onDemand": true
}

响应示例

{
    "returnObj": {
        "masterResourceStatus": "started",
        "regionID": "bb9fdb42056f11eda1610242ac110002",
        "masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
        "masterResourceID": "2ec9776a9ad94343b4ece701ce18e688",
        "masterOrderNO": "20220812171600203284",
        "resources": [
			{
				"orderID": "7ce378d78ff84b47b1eef7ff392ff021",
				"status": 2,
				"isMaster": true,
				"diskName": "ebs-newspec-test0211v7",
				"resourceType": "EBS",
				"updateTime": 1676081822000,
				"itemValue": 10,
				"startTime": 1676081818000,
				"createTime": 1676081789000,
				"diskID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
            }
        ]
    },
    "details": "",
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码