将PCI设备规格加载到云主机(AddPciDeviceSpecToVmInstance)

API请求

URLs

POST zstack/v1/pci-device-specs/{pciSpecUuid}/vm-instances/{vmInstanceUuid}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "pciDeviceNumber": 1.0
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"pciDeviceNumber":1.0}}' http://localhost:8080/zstack/v1/pci-device-specs/ace129cb77d93012bf47f839b9429881/vm-instances/16ecb900082437e8aaf554ce19620030

参数列表


名字	类型	位置	描述	起始版本
pciSpecUuid	String	url	PCI设备规格UUID	3.5.0
vmInstanceUuid	String	url	云主机UUID	3.5.0
pciDeviceNumber (可选)	Integer	body(包含在params结构中)		3.5.0
systemTags (可选)	List	body	系统标签	3.5.0
userTags (可选)	List	body	用户标签	3.5.0

API返回

返回示例

{
  "inventory": {
    "vmInstanceUuid": "ed0836204dbd496bb9cfa25f091d9d4a",
    "pciSpecUuid": "f9e3605232d343d99bca77ba13c1ca34",
    "pciDeviceNumber": 1.0,
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}


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

#error


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

#inventory


名字	类型	描述	起始版本
vmInstanceUuid	String	云主机UUID	3.5.0
pciSpecUuid	String	PCI设备规格UUID	3.5.0
pciDeviceNumber	Integer	需要为云主机挂载的符合设备规格的设备个数，默认为1	3.5.0
createDate	Timestamp	创建时间	3.5.0
lastOpDate	Timestamp	最后一次修改时间	3.5.0

SDK示例

Java SDK

AddPciDeviceSpecToVmInstanceAction action = new AddPciDeviceSpecToVmInstanceAction();
action.pciSpecUuid = "ace129cb77d93012bf47f839b9429881";
action.vmInstanceUuid = "16ecb900082437e8aaf554ce19620030";
action.pciDeviceNumber = 1.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddPciDeviceSpecToVmInstanceAction.Result res = action.call();

Python SDK

AddPciDeviceSpecToVmInstanceAction action = AddPciDeviceSpecToVmInstanceAction()
action.pciSpecUuid = "ace129cb77d93012bf47f839b9429881"
action.vmInstanceUuid = "16ecb900082437e8aaf554ce19620030"
action.pciDeviceNumber = 1.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddPciDeviceSpecToVmInstanceAction.Result res = action.call()