弹性裸金属管理(Plus)

创建块存储卷(CreateBlockVolume)

API请求

URLs

POST zstack/v1/block-volumes

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "example",     "description": "block volume test"   },   "systemTags": [],   "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8"  -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c"  -X POST -d '{"params":{"name":"example","description":"block volume test"}}'  http://localhost:8080/zstack/v1/block-volumes

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	资源名称	资源名称	4.7.11
description (可选)	String	body(包含在params结构中)	资源的详细描述	资源的详细描述	4.7.11
size	Long	body(包含在params结构中)	容量	容量	4.7.11
primaryStorageUuid	String	body(包含在params结构中)	主存储UUID	主存储UUID	4.7.11
accessPathId（可选）	Integer	body(包含在params结构中)	访问路径id	访问路径id	4.7.11
accessPathIqn（可选）	String	body(包含在params结构中)	访问路径iqn	访问路径iqn	5.1.0
burstTotalBw (可选)	Long	body(包含在params结构中)	突发带宽	突发带宽	4.7.11
burstTotalIops (可选)	Long	body(包含在params结构中)	突发IOPS	突发IOPS	4.7.11
maxTotalBw (可选)	Long	body(包含在params结构中)	最大带宽	最大带宽	4.7.11
maxTotalIops (可选)	Long	body(包含在params结构中)	最大IOPS	最大IOPS	4.7.11
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	资源UUID	4.7.11
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	标签UUID列表	4.7.11
systemTags (可选)	List	body	系统标签	系统标签	4.7.11
userTags (可选)	List	body	用户标签	用户标签	4.7.11
protocol (可选)	String	body(包含在params结构中)	卷所属协议	卷所属协议	5.1.0

API返回

返回示例

{   "inventory": {} }

名字	类型	描述	起始版本
success	boolean		4.7.11
inventory	VolumeInventory	详情参考inventory	4.7.11
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.7.11

#inventory

名字	类型	描述	起始版本
iscsiPath	String		4.7.11
vendor	String		4.7.11
uuid	String	资源的UUID，唯一标示该资源	4.7.11
name	String	资源名称	4.7.11
description	String	资源的详细描述	4.7.11
primaryStorageUuid	String	主存储UUID	4.7.11
vmInstanceUuid	String	云主机UUID	4.7.11
diskOfferingUuid	String	云盘规格UUID	4.7.11
rootImageUuid	String		4.7.11
installPath	String		4.7.11
type	String		4.7.11
format	String		4.7.11
size	Long		4.7.11
actualSize	Long		4.7.11
deviceId	Integer		4.7.11
state	String		4.7.11
status	String		4.7.11
createDate	Timestamp	创建时间	4.7.11
lastOpDate	Timestamp	最后一次修改时间	4.7.11
isShareable	Boolean		4.7.11
volumeQos	String		4.7.11
lastDetachDate	Timestamp		4.7.11
lastVmInstanceUuid	String		4.7.11

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	4.7.0
description	String	错误的概要描述	4.7.0
details	String	错误的详细信息	4.7.0
elaboration	String	保留字段，默认为null	4.7.0
opaque	LinkedHashMap	保留字段，默认为null	4.7.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	4.7.0

SDK示例

Java SDK

CreateBlockVolumeAction action = new CreateBlockVolumeAction(); action.name = "example"; action.description = "block volume test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateBlockVolumeAction.Result res = action.call();

Python SDK

CreateBlockVolumeAction action = CreateBlockVolumeAction() action.name = "example" action.description = "block volume test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateBlockVolumeAction.Result res = action.call()

获取访问路径列表(GetAccessPath)

API请求

URLs

GET zstack/v1/block-volumes/access/path/

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8"  -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c"  -X GET http://localhost:8080/zstack/v1/block-volumes/access/path?primaryStorageUuid=56963d0046b330839488e795b5109e44

参数列表

名字	类型	位置	描述	起始版本
systemTags (可选)	List	query	系统标签	4.7.11
userTags (可选)	List	query	用户标签	4.7.11
primaryStorageUuid	String	query	主存储UUID	4.7.11

API返回

返回示例

{   "pathInfos": [     {       "accessPathId": 1,       "accessPathIqn": "iqn",       "targetCount": 1     }   ] }

名字	类型	描述	起始版本
success	boolean		4.7.11
inventory	VolumeInventory	详情参考pathInfos	4.7.11
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.7.11

#pathInfos

名字	类型	描述	起始版本
name	String	资源名称	4.7.11
accessPathId	String	访问路径id	4.7.11
accessPathIqn	String	访问路径iqn	4.7.11
targetCount	Integer	关联目标数量	4.7.11
gatewayIps	List	网关ip	4.7.11

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

SDK示例

Java SDK

CreateBlockVolumeAction action = new CreateBlockVolumeAction(); action.name = "example"; action.description = "block volume test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateBlockVolumeAction.Result res = action.call();

Python SDK

CreateBlockVolumeAction action = CreateBlockVolumeAction() action.name = "example" action.description = "block volume test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateBlockVolumeAction.Result res = action.call()

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持

创建块存储卷(CreateBlockVolume)

API请求

API返回

SDK示例

获取访问路径列表(GetAccessPath)

API请求

API返回

SDK示例

客户评论

撰写评论

产品

解决方案

支持

联系