虚拟机相关接口

加载网卡到虚拟机

POST/zstack/v1/vm-instances/{vmInstanceUuid}/nices/{vmNicUuid}

Headers

Authorization: OAuth the-session-uuid

Body

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

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/vm-instances/4fea63520ff63f5f9856acd619add4f5/nices/8b22e01e4bf43b1dab1530d2b362bbc5

参数列表

名字类型位置描述可选值起始版本
vmNicUuidStringurl虚拟机网卡UUID 4.0.0
vmInstanceUuidListurl虚拟机UUID 4.0.0
systemTags (可选)Listbody系统标签 4.0.0
userTags (可选)Listbody用户标签 4.0.0

API返回

返回示例

{
  "inventory": {
    "uuid": "afbd67886d773a45af9a20071bcb09bb",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "4b9ddab3f5f738f1a0161f5cf5f33f5c",
    "clusterUuid": "d7061d85666a380cb3dda4cc7f9f16ee",
    "imageUuid": "179a3412da4a32faa927eae552348907",
    "hostUuid": "6ee062370eee3df58623fa99be0b2ce0",
    "lastHostUuid": "09fdbebbaea73df79b744ad0d4bd7088",
    "instanceOfferingUuid": "6dc0db981e68348e89ac79ed18fa4b24",
    "rootVolumeUuid": "a876397202ac3d1daf9f4ea67e75e13d",
    "platform": "Linux",
    "defaultL3NetworkUuid": "3baaf68d632f3e9aa12be139d58d968e",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "b9415d324b50301e923a990bf65352d0",
        "vmInstanceUuid": "afbd67886d773a45af9a20071bcb09bb",
        "usedIpUuid": "76a49549cb183d35865276187afb482b",
        "l3NetworkUuid": "3baaf68d632f3e9aa12be139d58d968e",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "a876397202ac3d1daf9f4ea67e75e13d",
        "name": "Root-Volume-For-VM-afbd67886d773a45af9a20071bcb09bb",
        "primaryStorageUuid": "336625bac9e0326b9a9abc7801ef2c86",
        "vmInstanceUuid": "afbd67886d773a45af9a20071bcb09bb",
        "diskOfferingUuid": "475f8e09aae2389ea6945b46601aa683",
        "rootImageUuid": "179a3412da4a32faa927eae552348907",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-a876397202ac3d1daf9f4ea67e75e13d/a876397202ac3d1daf9f4ea67e75e13d.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error4.0.0
inventoryVmInstanceInventory详情参考inventory4.0.0

error

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

inventory

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.0.0
nameString资源名称4.0.0
descriptionString资源的详细描述4.0.0
zoneUuidString数据中心UUID4.0.0
clusterUuidString集群UUID4.0.0
imageUuidString镜像UUID4.0.0
hostUuidString主机UUID4.0.0
lastHostUuidString 4.0.0
instanceOfferingUuidString 4.0.0
rootVolumeUuidString根硬盘UUID4.0.0
platformString 4.0.0
architectureString 0.6
defaultL3NetworkUuidString 4.0.0
typeString 4.0.0
hypervisorTypeString 4.0.0
memorySizeLong 4.0.0
cpuNumInteger 4.0.0
cpuSpeedLong 4.0.0
allocatorStrategyString 4.0.0
createDateTimestamp创建时间4.0.0
lastOpDateTimestamp最后一次修改时间4.0.0
stateString 4.0.0
guestOsTypeString 4.1.2
vmNicsList详情参考vmNics4.0.0
allVolumesList详情参考allVolumes4.0.0
vmCdRomsList详情参考vmCdRoms0.6

vmNics

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.0.0
vmInstanceUuidString虚拟机UUID4.0.0
l3NetworkUuidString分布式端口组UUID4.0.0
ipStringIP地址4.0.0
macStringMAC地址4.0.0
hypervisorTypeString虚拟化类型4.0.0
netmaskString子网掩码4.0.0
gatewayString网关4.0.0
metaDataString 4.0.0
ipVersionIntegerIP地址版本4.0.0
driverTypeString 4.7.13
internalNameString 4.7.13
deviceIdInteger设备ID4.0.0
typeString网卡类型4.0.0
stateString网卡状态4.7.13
createDateTimestamp创建时间4.0.0
lastOpDateTimestamp最后一次修改时间4.0.0
usedIpsList详情参考usedIps4.0.0

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.0.0
ipRangeUuidStringIP段UUID4.0.0
l3NetworkUuidString分布式端口组UUID4.0.0
ipVersionIntegerIP协议号4.0.0
ipStringIP地址4.0.0
netmaskString网络掩码4.0.0
gatewayString网关地址4.0.0
usedForString 4.0.0
ipInLonglong 4.0.0
vmNicUuidString虚拟机网卡UUID4.0.0
createDateTimestamp创建时间4.0.0
lastOpDateTimestamp最后一次修改时间4.0.0

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.0.0
nameString资源名称4.0.0
descriptionString资源的详细描述4.0.0
primaryStorageUuidString数据存储UUID4.0.0
vmInstanceUuidString虚拟机UUID4.0.0
diskOfferingUuidString硬盘规格UUID4.0.0
rootImageUuidString硬盘根镜像UUID4.0.0
installPathString硬盘在数据存储上的路径4.0.0
typeString硬盘类型，数据硬盘/根硬盘4.0.0
formatString硬盘格式4.0.0
sizeLong硬盘大小4.0.0
actualSizeLong硬盘真实大小4.0.0
deviceIdInteger 4.0.0
stateString硬盘是否开启4.0.0
statusString硬盘状态4.0.0
createDateTimestamp创建时间4.0.0
lastOpDateTimestamp最后一次修改时间4.0.0
isShareableBoolean是否共享硬盘4.0.0
volumeQosString硬盘Qos，格式如total=10485764.0.0
lastDetachDateTimestamp 4.7.13
lastVmInstanceUuidString 4.7.13

vmCdRoms

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
deviceIdInteger 4.7.13
isoUuidString 4.7.13
isoInstallPathString 4.7.13
nameString资源名称4.7.13
descriptionString资源的详细描述4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13

SDK示例

Java SDK

AttachVmNicToVmAction action = new AttachVmNicToVmAction();
action.vmNicUuid = "8b22e01e4bf43b1dab1530d2b362bbc5";
action.vmInstanceUuid = "4fea63520ff63f5f9856acd619add4f5";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachVmNicToVmAction.Result res = action.call();

Python SDK

action = AttachVmNicToVmAction()
action.vmNicUuid = "8b22e01e4bf43b1dab1530d2b362bbc5"
action.vmInstanceUuid = "4fea63520ff63f5f9856acd619add4f5"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

POST修改虚拟机网卡分布式端口组

上一页

DELETE删除虚拟机网卡

下一页