API文档
云服务器相关接口
云盘相关接口
创建云盘

1. 创建云盘

本接口用于创建云盘。

  1. 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
  2. 本接口为异步接口。当创建云盘请求下发成功后会返回一个异步任务进度信息(jobUuid)。通过 jobUuid 可以查询出当前异步任务执行情况。如果异步任务正在执行,返回的内容里 done=false、success=false,并有进度值显示;如果异步任务执行成功完成,返回的内容里 done=true、success=true;如果异步任务执行失败,返回的内容里 done=true,success=false。

1.1. 接口说明

本接口所属服务类型为 ebs

本接口操作类型为 CreateDisks

1.1.1. 请求路径

POST {baseUrl}/v3/ebs/CreateDisks

1.1.2. 请求体

{
  "zoneCode": "cn-zhongwei-a",
  "snapUuid": "",
  "diskType": "HDD",
  "diskSize": 20,
  "payPeriod": 1,
  "aliasName": "ebs-xwhwjnhu",
  "autoContinue": false,
  "ecsUuid": "eb4fc7cd-20ca-45be-ae7e-2eaba7bb0526",
  "billingType": "PrePaid"
}

请求体内容说明

属性名属性类型是否必须默认值说明
zoneCodeString可用区编码
aliasNameString云盘别名。
diskTypeString云盘类型
diskSizeInteger云盘大小,单位 GB。
autoContinueBooleanfalse资源到期是否自动续费。true表示到期后自动续费;false表示到期后自动删除。
billingTypeString通常需要传入按需 PostPaid 和包月 PrePaid 两值其一
payPeriodInteger购买月数,例如: payPeriod=1表示购买1个月
ecsUuidString创建云盘自动挂载到的云服务器
snapUUidString待创建云盘基于哪个快照 UUID

1.1.3. 返回内容

{
  "code": 200,
  "message": "成功创建云盘",
  "data": [
    {
      "jobUuid": "743fdb6383eb47e88f02ce1d13a6245d",
      "success": false,
      "progress": 0,
      "type": "CreateEBS",
      "done": false,
      "resourceUuid": "9d0a06b8-cd8a-4bd5-af8e-445b8b63b0e7"
    }
  ]
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息。
dataArray创建结果

异步任务进度信息

属性名属性类型说明
jobUuidString异步任务唯一编码
successBoolean异步任务是否执行成功
progressDouble异步任务执行进度。0-100%
typeString异步任务类型
doneBoolean异步任务是否执行完成
resourceUuidString异步任务所处理的资源 Uuid