跳转到主要内容
API Explorer|API Explorer
资源中心/弹性裸金属管理(Plus)
POSTElastic Bare Metal Management(Plus)起始版本 4.7.11同步需要认证

创建块存储卷

创建块存储卷

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • sizeLong必填

      容量

    • primaryStorageUuidString必填

      主存储UUID

    • accessPathIdInteger

      访问路径id

    • accessPathIqnString

      访问路径iqn

    • burstTotalBwLong

      突发带宽

    • burstTotalIopsLong

      突发IOPS

    • maxTotalBwLong

      最大带宽

    • maxTotalIopsLong

      最大IOPS

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

  • protocolString

    认证协议。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoryVolumeInventory必填

    详情参考inventory

    • iscsiPathString必填

      iscsi路径。

    • vendorString必填

      暂无描述。

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • primaryStorageUuidString必填

      主存储UUID

    • vmInstanceUuidString必填

      云主机UUID

    • diskOfferingUuidString必填

      云盘规格UUID

    • rootImageUuidString必填

      根镜像UUID。

    • installPathString必填

      安装路径。

    • typeString必填

      类型。

    • formatString必填

      数据格式或导出格式。

    • sizeLong必填

      返回记录数。

    • actualSizeLong必填

      实际大小。

    • deviceIdInteger必填

      设备ID。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • isShareableBoolean必填

      是否可分享。

    • volumeQosString必填

      暂无描述。

    • lastDetachDateTimestamp必填

      最近一次detach时间。

    • lastVmInstanceUuidString必填

      最近一次云主机实例UUID。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

POST/zstack/v1/block-volumes

/zstack/v1/block-volumes

操作 ID

CreateBlockVolume

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/block-volumes' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","size":1,"primaryStorageUuid":"<primaryStorageUuid>","accessPathId":1,"accessPathIqn":"<accessPathIqn>","burstTotalBw":1,"burstTotalIops":1,"maxTotalBw":1,"maxTotalIops":1,"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"],"protocol":"<protocol>"}'

响应示例

200
{ "inventory": {} }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史