跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
POSTVM Related Interfaces起始版本 5.0.0同步需要认证

从元数据注册虚拟机

从元数据注册虚拟机

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • metadataPathString必填

      元数据文件在数据存储上的路径

    • primaryStorageUuidString必填

      目标数据存储UUID

    • zoneUuidString必填

      数据中心UUID

    • clusterUuidString必填

      集群UUID

    • hostUuidString

      物理机UUID

    • nameString

      虚拟机名称

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功

  • inventoryVmInstanceInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      数据中心 UUID

    • clusterUuidString必填

      集群 UUID

    • imageUuidString必填

      镜像 UUID

    • hostUuidString必填

      主机 UUID

    • lastHostUuidString必填

      上一次启动的主机 UUID

    • instanceOfferingUuidString必填

      计算规格 UUID, 已废弃

    • rootVolumeUuidString必填

      根硬盘 UUID

    • platformString必填

      虚拟机的平台, 是 Windows / Linux 还是其它

    • architectureString必填

      虚拟机架构, 是 x86_64 / aarch64 还是其它

    • defaultL3NetworkUuidString必填

      默认使用的分布式端口组 UUID

    • typeString必填

      虚拟机类型, 是用户使用虚拟机还是平台特殊用途的虚拟机

    • hypervisorTypeString必填

      虚拟机虚拟化类型, 一般为 KVM

    • memorySizeLong必填

      内存大小

    • cpuNumInteger必填

      CPU 数量

    • cpuSpeedLong必填

      CPU 速度

    • allocatorStrategyString必填

      虚拟机分配策略

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      虚拟机是否启用的状态

    • guestOsTypeString必填

      虚拟机宿主操作系统类型

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

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

      • vmInstanceUuidString必填

        虚拟机UUID

      • l3NetworkUuidString必填

        分布式端口组UUID

      • ipString必填

        来源IP地址。

      • macString必填

        暂无描述。

      • hypervisorTypeString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • ipVersionInteger必填

        IP版本。

      • driverTypeString必填

        暂无描述。

      • internalNameString必填

        内部名称。

      • deviceIdInteger必填

        设备ID。

      • typeString必填

        类型。

      • stateString必填

        网卡状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • usedIpsList必填

        详情参考usedIps

        • uuidString必填

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

        • ipRangeUuidString必填

          IP段UUID

        • l3NetworkUuidString必填

          分布式端口组UUID

        • ipVersionInteger必填

          IP协议号

        • ipString必填

          IP地址

        • netmaskString必填

          子网掩码

        • gatewayString必填

          网关地址

        • usedForString必填

          分配原因

        • ipInLonglong必填

          Long存储的IP地址，仅ipv4有效

        • vmNicUuidString必填

          虚拟机网卡UUID

        • 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必填

        是否可分享。

      • volumeQosString必填

        暂无描述。

      • lastDetachDateTimestamp必填

        最近一次detach时间。

      • lastVmInstanceUuidString必填

        最近一次云主机实例UUID。

    • vmCdRomsList必填

      详情参考vmCdRoms

      • uuidString必填

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

      • vmInstanceUuidString必填

        虚拟机UUID

      • deviceIdInteger必填

        设备ID。

      • isoUuidString必填

        暂无描述。

      • isoInstallPathString必填

        iso安装路径。

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

POST/zstack/v1/vm-instances/metadata/register

/zstack/v1/vm-instances/metadata/register

操作 ID

RegisterVmInstanceFromMetadata

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/vm-instances/metadata/register' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"metadataPath":"<metadataPath>","primaryStorageUuid":"<primaryStorageUuid>","zoneUuid":"<zoneUuid>","clusterUuid":"<clusterUuid>","hostUuid":"<hostUuid>","name":"<name>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "21d608564fe438fd8b6c29fde66a4881", "name": "recovered-vm" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史