You need to enable JavaScript to run this app.
导航
创建云盘
最近更新时间:2024.07.02 10:27:10首次发布时间:2024.03.12 19:08:28

本接口用于创建云盘。您可以一次创建一个或多个云盘。

使用说明

前提条件:
如果您计划在某个节点下创建云盘,须确保该节点下已创建过边缘实例。您可以通过 ListInstancesListVPCInstances 来查询相关节点。
使用限制:

  • 单个节点下,默认最多可以创建10块云盘。
  • 当前仅能够在部分节点下创建云盘。获取相关节点列表,请提交工单或联系客服人员。

注意事项:
创建云盘后,您需要手动挂载云盘并完成云盘初始化。相关操作,请参见挂载云盘初始化云盘

请求说明

  • 请求方式:POST
  • 请求地址:https://veenedge.volcengineapi.com?Action=CreateEbsInstances&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

参数

类型

是否必选

示例值

描述

Action

String

CreateEbsInstances

公共参数。该参数表示接口名称。取值:CreateEbsInstances。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

Body

参数

类型

是否必选

示例值

描述

cluster_name

String

**ct03

云盘所属的节点的名称。

charge_type

String

HourUsed

云盘的计费类型。取值范围:

  • HourUsed:按量计费。

ebs_type

String

data

云盘的类型。取值范围:

  • data:数据盘

storage_type

String

CloudBlockSSD

存储类型。取值范围:

  • CloudBlockSSD:SSD 型云盘。

capacity

String

200

云盘的容量。取值范围:20~1000。单位:GB。取值须为10的倍数。
如需更大的云盘容量,请提交工单进行申请。

number

Integer

1

需要创建的云盘的数量。取值范围:1~100。
单个节点下,默认最多可以创建 10 块云盘。

name

String

disk_01

云盘的名称。
命名规则如下:

  • 允许 5~80 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

当您批量创建云盘时,系统将为自定义云盘名称添加数字后缀。举例:<自定义云盘名称>-1,<自定义云盘名称>-2。

desc

String

disk_01_for_test

云盘的描述信息。
描述信息须符合以下要求:

  • 允许 0~255 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

project

String

default

云盘所属的项目。不指定该参数时,云盘默认加入 default 项目。

delete_with_res

Boolean

false

是否随挂载的边缘实例一起删除。取值范围:

  • true:边缘实例被删除时,云盘也会一起被删除。
  • false (默认值):边缘实例被删除时,云盘会被保留。

res_id

String

veen1020125208252511****

云盘要挂载到的边缘实例的 ID。
如果不指定该参数,代表暂不将云盘挂载到边缘实例。
不同规格的边缘实例可挂载的云盘的数量有所不同。详情请参见配额说明

返回参数

参数

类型

示例值

描述

ebs_ids

[]String

["disk-tvs2gmln****"]

创建的云盘的 ID 的列表。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateEbsInstances&Version=2021-04-30
&<其他公共参数>
{
    "cluster_name": "**ct03",
    "charge_type": "HourUsed",
    "ebs_type": "data",
    "storage_type": "CloudBlockSSD",
    "capacity": "50",
    "number": 1,
    "name": "disk_01",
    "project": "default",
    "delete_with_res": false,
    "res_id": "veen0522220112101114****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240125201734F7E07C271D25ED66****",
        "Action": "CreateEbsInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "ebs_ids": [
            "disk-ld62bnkzst5****"
        ]
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码