Skip to main content
API Explorer|API Explorer
Compute Management/VM Related Interfaces
POSTVM Related InterfacesSince 5.0.0SynchronousAuth Required

Register a VM Instance from Metadata

Register a VM Instance from Metadata

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • metadataPathStringRequired

      Path of the metadata file on primary storage

    • primaryStorageUuidStringRequired

      Target primary storage UUID

    • zoneUuidStringRequired

      Zone UUID

    • clusterUuidStringRequired

      Cluster UUID

    • hostUuidString

      Host UUID

    • nameString

      VM instance name

    • tagUuidsList

      List of tag UUIDs

  • systemTagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    Whether the operation succeeded

  • inventoryVmInstanceInventoryRequired

    For details, see inventory

    • uuidStringRequired

      Resource UUID, which uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Detailed description of the resource

    • zoneUuidStringRequired

      Zone UUID

    • clusterUuidStringRequired

      Cluster UUID

    • imageUuidStringRequired

      Image UUID

    • hostUuidStringRequired

      Host UUID

    • lastHostUuidStringRequired

      Host UUID used for the last startup

    • instanceOfferingUuidStringRequired

      Instance offering UUID. This field is deprecated.

    • rootVolumeUuidStringRequired

      Root volume UUID

    • platformStringRequired

      VM instance platform, such as Windows, Linux, or another platform

    • architectureStringRequired

      VM instance architecture, such as x86_64, aarch64, or another architecture

    • defaultL3NetworkUuidStringRequired

      Default distributed port group UUID

    • typeStringRequired

      VM instance type, indicating whether the VM instance is used by a user or for special platform purposes

    • hypervisorTypeStringRequired

      VM instance hypervisor type, usually KVM

    • memorySizeLongRequired

      Memory size

    • cpuNumIntegerRequired

      Number of CPUs

    • cpuSpeedLongRequired

      CPU speed

    • allocatorStrategyStringRequired

      VM instance allocation strategy

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • stateStringRequired

      Status indicating whether the VM instance is enabled

    • guestOsTypeStringRequired

      Guest operating system type of the VM instance

    • vmNicsListRequired

      For details, see vmNics

      • uuidStringRequired

        Resource UUID, which uniquely identifies the resource

      • vmInstanceUuidStringRequired

        VM instance UUID

      • l3NetworkUuidStringRequired

        Distributed port group UUID

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • hypervisorTypeStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        IP版本。

      • driverTypeStringRequired

        No description provided.

      • internalNameStringRequired

        内部名称。

      • deviceIdIntegerRequired

        设备ID。

      • typeStringRequired

        类型。

      • stateStringRequired

        NIC state

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

      • usedIpsListRequired

        For details, see usedIps

        • uuidStringRequired

          Resource UUID, which uniquely identifies the resource

        • ipRangeUuidStringRequired

          IP range UUID

        • l3NetworkUuidStringRequired

          Distributed port group UUID

        • ipVersionIntegerRequired

          IP protocol number

        • ipStringRequired

          IP address

        • netmaskStringRequired

          Subnet mask

        • gatewayStringRequired

          Gateway address

        • usedForStringRequired

          Allocation reason

        • ipInLonglongRequired

          IP address stored as a Long value. This field is valid only for IPv4.

        • vmNicUuidStringRequired

          VM NIC UUID

        • createDateTimestampRequired

          Creation time

        • lastOpDateTimestampRequired

          Last modification time

    • allVolumesListRequired

      For details, see allVolumes

      • uuidStringRequired

        Resource UUID, which uniquely identifies the resource

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • primaryStorageUuidStringRequired

        Primary storage UUID

      • vmInstanceUuidStringRequired

        VM instance UUID

      • diskOfferingUuidStringRequired

        Disk offering UUID

      • rootImageUuidStringRequired

        根镜像UUID。

      • installPathStringRequired

        安装路径。

      • typeStringRequired

        类型。

      • formatStringRequired

        数据格式或导出格式。

      • sizeLongRequired

        返回记录数。

      • actualSizeLongRequired

        实际大小。

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        当前状态。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

      • isShareableBooleanRequired

        是否可分享。

      • volumeQosStringRequired

        No description provided.

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      For details, see vmCdRoms

      • uuidStringRequired

        Resource UUID, which uniquely identifies the resource

      • vmInstanceUuidStringRequired

        VM instance UUID

      • deviceIdIntegerRequired

        设备ID。

      • isoUuidStringRequired

        No description provided.

      • isoInstallPathStringRequired

        iso安装路径。

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

  • errorErrorCodeRequired

    For details, see error

    • codeStringRequired

      Error code, which is the globally unique identifier of the error, such as SYS.1000 or HOST.1001

    • descriptionStringRequired

      Summary description of the error

    • detailsStringRequired

      Detailed information about the error

    • elaborationStringRequired

      Reserved field. The default value is null.

    • opaqueLinkedHashMapRequired

      Reserved field. The default value is null.

    • causeErrorCodeRequired

      Root error that caused the current error. If there is no original error, this field is null.

Endpoint

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

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

Operation ID

RegisterVmInstanceFromMetadata

Permalink

Request Example

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>"]}'

Response Example

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

Change History

This API has no change history records yet.

View all change history