跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云主机相关接口
POSTVM Instance Operations起始版本 0.6同步需要认证

创建云主机

创建云主机

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      云主机名称

    • instanceOfferingUuidString必填

      计算规格UUID 指定云主机的CPU、内存等参数。

    • imageUuidString必填

      镜像UUID 云主机的根云盘会从该字段指定的镜像创建。

    • l3NetworkUuidsList必填

      三层网络UUID列表 可指定一个或多个三层网络，云主机会在每个三层网络上创建一个网卡。

    • typeString

      云主机类型 保留字段，无需指定。

    • rootDiskOfferingUuidString

      根云盘规格UUID 如果imageUuid字段指定的镜像类型是ISO，该字段必须指定以确定需要创建的根云盘大小。 如果镜像类型是非ISO，该字段无需指定。

    • dataDiskSizesList

      自定义云盘大小列表。可以指定一个或多个云盘大小（可重复）为云主机创建一个或多个数据云盘。

    • dataDiskOfferingUuidsList

      云盘规格UUID列表 可指定一个或多个云盘规格UUID（UUID可以重复）为云主机创建一个或多个数据云盘。

    • zoneUuidString

      区域UUID 若指定，云主机会在指定区域创建。

    • clusterUuidString

      集群UUID 若指定，云主机会在指定集群创建，该字段优先级高于zoneUuid。

    • hostUuidString

      物理机UUID 若指定，云主机会在指定物理机创建，该字段优先级高于zoneUuid和clusterUuid。

    • primaryStorageUuidForRootVolumeString

      主存储UUID 若指定，云主机的根云盘会在指定主存储创建。

    • descriptionString

      云主机的详细描述

    • defaultL3NetworkUuidString

      默认三层网络UUID 当l3NetworkUuids指定了多个三层网络时，该字段指定提供默认路由的三层网络。 若不指定，l3NetworkUuids的第一个网络被选为默认网络。

    • resourceUuidString

      资源UUID 若指定，云主机会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

    • strategyString

      云主机创建策略 创建后立刻启动 创建后不启动

    • dataVolumeSystemTagsOnIndexMap

      暂无描述。

  • systemTagsList

    云主机系统标签

  • userTagsList

    云主机用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryVmInstanceInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      物理机UUID

    • lastHostUuidString必填

      上一次运行云主机的物理机UUID

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      云主机运行平台

    • defaultL3NetworkUuidString必填

      默认三层网络UUID

    • typeString必填

      云主机类型

    • hypervisorTypeString必填

      云主机的hypervisor类型

    • memorySizeLong必填

      内存大小

    • cpuNumInteger必填

      cpu数量

    • cpuSpeedLong必填

      cpu主频

    • allocatorStrategyString必填

      分配策略

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      云主机的可用状态

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        来源IP地址。

      • macString必填

        MAC地址。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        已预留字段内部使用。

      • deviceIdInteger必填

        设备ID。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • allVolumesList必填

      详情参考allVolumes

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • primaryStorageUuidString必填

        主存储UUID

      • vmInstanceUuidString必填

        云主机UUID

      • diskOfferingUuidString必填

        云盘规格UUID

      • rootImageUuidString必填

        UUID根量镜像。

      • installPathString必填

        安装路径。

      • typeString必填

        类型。

      • formatString必填

        数据格式或导出格式。

      • sizeLong必填

        返回记录数。

      • actualSizeLong必填

        实际大小量。

      • deviceIdInteger必填

        设备ID。

      • stateString必填

        当前状态。

      • statusString必填

        状态信息。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否量共享。

请求地址

POST/zstack/v1/vm-instances

/zstack/v1/vm-instances

操作 ID

CreateVmInstance

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/vm-instances' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","instanceOfferingUuid":"<instanceOfferingUuid>","imageUuid":"<imageUuid>","l3NetworkUuids":["<l3NetworkUuids>"],"type":"<type>","rootDiskOfferingUuid":"<rootDiskOfferingUuid>","dataDiskSizes":["<dataDiskSizes>"],"dataDiskOfferingUuids":["<dataDiskOfferingUuids>"],"zoneUuid":"<zoneUuid>","clusterUuid":"<clusterUuid>","hostUuid":"<hostUuid>","primaryStorageUuidForRootVolume":"<primaryStorageUuidForRootVolume>","description":"<description>","defaultL3NetworkUuid":"<defaultL3NetworkUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"strategy":"<strategy>","dataVolumeSystemTagsOnIndex":{}},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "6efab7159c6932429c6b0e7e0b64b660", "name": "Test-VM", "description": "web server VM", "zoneUuid": "d10bd7a9565138efaf6171db8e18fa7d", "clusterUuid": "692c71639d873bf6a356cd8e285d0d9c", "imageUuid": "28061e65e48037eda71b53a0732bf087", "hostUuid": "f877177de7bd377e811bc6313878b2b1", "lastHostUuid": "a3ccdc90a600334f994c69aee4270ac5", "instanceOfferingUuid": "9a874241f867333ca0bf0ab2134f8515", "rootVolumeUuid": "f52d7c94d69d3bbb97d36a270fe910c3", "platform": "Linux", "defaultL3NetworkUuid": "2ac1b70fdb0f38769a29c6ebd0262cca", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running", "vmNics": [ { "uuid": "0dfbb8a297e9349ea8799c4ce48c6d10", "vmInstanceUuid": "6efab7159c6932429c6b0e7e0b64b660", "usedIpUuid": "39b57596a8ba35289bd9f40efceeae03", "l3NetworkUuid": "2ac1b70fdb0f38769a29c6ebd0262cca", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0.0, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "allVolumes": [ { "uuid": "f52d7c94d69d3bbb97d36a270fe910c3", "name": "Root-Volume-For-VM-6efab7159c6932429c6b0e7e0b64b660", "primaryStorageUuid": "4ed5bbb150a034b5917e7e6c9c4b8170", "vmInstanceUuid": "6efab7159c6932429c6b0e7e0b64b660", "diskOfferingUuid": "0521187274d73f5b936c22b145384c74", "rootImageUuid": "28061e65e48037eda71b53a0732bf087", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f52d7c94d69d3bbb97d36a270fe910c3/f52d7c94d69d3bbb97d36a270fe910c3.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史