弹性裸金属管理(Plus)

ZStack Cloud 4.8.10>开发手册>资源中心>弹性裸金属管理(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	4.7.11
accessPathId	Integer	body(包含在params结构中)	访问路径id	4.7.11
accessPathIqn	String	body(包含在params结构中)	访问路径iqn	4.7.11
burstTotalBw (可选)	Long	body(包含在params结构中)	突发带宽	4.7.11
burstTotalIops (可选)	Long	body(包含在params结构中)	突发IOPS	4.7.11
maxTotalBw (可选)	Long	body(包含在params结构中)	最大带宽	4.7.11
maxTotalIops (可选)	Long	body(包含在params结构中)	最大IOPS	4.7.11
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	4.7.11
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	4.7.11
systemTags (可选)	List	body	系统标签	4.7.11
userTags (可选)	List	body	用户标签	4.7.11

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()

更新xsky类型的块存储卷(UpdateXskyBlockVolume)

API请求

URLs

PUT zstack/v1/xsky/block-volumes/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{   "updateXskyBlockVolume": {     "name": "example"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8"  -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c"  -X PUT -d '{"updateXskyBlockVolume":{"name":"example"}}'  http://localhost:8080/zstack/v1/xsky/block-volumes/eeb07fe1a24833959f75c38b9c7e4132/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	4.7.11
name (可选)	String	body(包含在updateXskyBlockVolume结构中)	资源名称	4.7.11
description (可选)	String	body(包含在updateXskyBlockVolume结构中)	资源的详细描述	4.7.11
burstTotalBw (可选)	Long	body(包含在updateXskyBlockVolume结构中)		4.7.11
burstTotalIops (可选)	Long	body(包含在updateXskyBlockVolume结构中)		4.7.11
maxTotalBw (可选)	Long	body(包含在updateXskyBlockVolume结构中)		4.7.11
maxTotalIops (可选)	Long	body(包含在updateXskyBlockVolume结构中)		4.7.11
systemTags (可选)	List	body	系统标签	4.7.11
userTags (可选)	List	body	用户标签	4.7.11

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ 	"error": { 		"code": "SYS.1001", 		"description": "A message or a operation timeout", 		"details": "Create VM on KVM timeout after 300s" 	} }

SDK示例

Java SDK

UpdateXskyBlockVolumeAction action = new UpdateXskyBlockVolumeAction(); action.uuid = "eeb07fe1a24833959f75c38b9c7e4132"; action.name = "example"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateXskyBlockVolumeAction.Result res = action.call();

Python SDK

UpdateXskyBlockVolumeAction action = UpdateXskyBlockVolumeAction() action.uuid = "eeb07fe1a24833959f75c38b9c7e4132" action.name = "example" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" UpdateXskyBlockVolumeAction.Result res = action.call()