CreateDisks

1. 接口描述

本接口用于创建一个或多个云硬盘。

注意事项

  • 本接口为异步接口,当创建云硬盘请求下发成功后会返回一个云硬盘ID列表,此时创建云硬盘操作并未立即完成。云硬盘创建结果可以通过 DescribeDisks 查询。如果能够查询到对应云硬盘数据且状态为AVAILABLE则代表云硬盘创建成功,如果创建时指定了挂载到某个实例,则当状态为IN_USE时则代表挂载成功。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

zoneId

String

云硬盘所属的可用区ID。

diskName

String

云盘名称。

范围1到64个字符。

仅支持输入字母、数字、-/_和英文句点(.)。

且必须以数字或字母开头和结尾。

diskSize

Integer

云硬盘大小,单位GiB。

diskAmount

Integer

需要创建的云硬盘的数量。

可选值范围:[1, 50]。

默认值:1。

instanceId

String

云硬盘挂在的实例ID。

resourceGroupId

String

云硬盘所在的资源组ID。

如不指定则放入默认资源组。

diskCategory

String

云硬盘种类。

Basic NVMe SSD: 经济型 NVMe SSD。

Standard NVMe SSD: 标准型 NVMe SSD。

默认为Standard NVMe SSD。

默认值:Standard NVMe SSD。

snapshotId

String

使用快照ID进行创建。

如果传入则根据此快照创建云硬盘,快照的云盘类型必须为数据盘快照。

marketingOptions

市场营销的相关选项。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

diskIds

Array of String

创建的云硬盘ID列表。

orderNumber

String

本次创建对应的订单编号。

4. 代码示例

1. 创建1块30G大小的云硬盘。

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateDisks
<Common Request Params>

Request:
{
  "diskName": "Test-Disk",
  "diskSize": 30,
  "diskAmount": 1,
  "zoneId": "asia-east-1a"
}

Response:
{
  "requestId": "T842EE571-4490-4AFE-9F17-931030D3B4F9",
  "response": {
    "requestId": "T842EE571-4490-4AFE-9F17-931030D3B4F9",
    "diskIds": [
      "<diskId>"
    ],
    "orderNumber": "<orderNumber>"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

400

INVALID_ILLEGAL_DISK_SIZE

云硬盘大小超出最大(小)值限制。

404

INVALID_ZONE_NOT_FOUND

可用区不存在。

400

LIMIT_EXCEEDED_INSTANCE_CAN_ATTACH

超出实例可挂载云硬盘的最大数量。

404

INVALID_INSTANCE_NOT_FOUND

服务器实例不存在。

404

INVALID_INSTANCE_OR_ZONE_CANNOT_BE_BOTH_EMPTY

实例和区域不能同时为空。

400

INVALID_CHARGE_TYPE

不支持后付费计费类型。

400

INVALID_DISK_CATEGORY_ZONE_NO_SELL

指定的云硬盘种类在指定的区域未开售。

最后更新于