虚拟机相关接口

获取虚拟机设备地址

GET/zstack/v1/vm-instances/devices

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/vm-instances/devices?uuid=a761ac08ca483af4a81d9ed3d9930ef4&resourceTypes=VolumeVO

参数列表

名字类型位置描述可选值起始版本
uuidStringquery虚拟机UUID 3.10.0
resourceTypesListquery资源类型VolumeVO3.10.0
systemTags (可选)Listquery系统标签 3.10.0
userTags (可选)Listquery用户标签 3.10.0

API返回

返回示例

{
  "addresses": {
    "VolumeVO": [
      {
        "address": "0000:01:00:0",
        "addressType": "pci",
        "deviceType": "disk",
        "resourceType": "VolumeVO"
      }
    ]
  }
}
名字类型描述起始版本
addressesMap设备地址详情3.10.0
successboolean 3.10.0
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error3.10.0

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10013.10.0
descriptionString错误的概要描述3.10.0
detailsString错误的详细信息3.10.0
elaborationString保留字段,默认为null3.10.0
opaqueLinkedHashMap保留字段,默认为null3.10.0
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null3.10.0

SDK示例

Java SDK

GetVmDeviceAddressAction action = new GetVmDeviceAddressAction();
action.uuid = "a761ac08ca483af4a81d9ed3d9930ef4";
action.resourceTypes = asList("VolumeVO");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmDeviceAddressAction.Result res = action.call();

Python SDK

GetVmDeviceAddressAction action = GetVmDeviceAddressAction()
action.uuid = "a761ac08ca483af4a81d9ed3d9930ef4"
action.resourceTypes = [VolumeVO]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmDeviceAddressAction.Result res = action.call()