Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/VM Instance Operations
GETVM Instance OperationsSince 0.6SynchronousAuth Required

QueryVmInstance

QueryVmInstance

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • zoneUuidStringRequired

      The zone UUID.

    • clusterUuidStringRequired

      The cluster UUID.

    • imageUuidStringRequired

      The image UUID.

    • hostUuidStringRequired

      The host UUID.

    • lastHostUuidStringRequired

      最近一次主机UUID。

    • instanceOfferingUuidStringRequired

      The instance offering UUID.

    • rootVolumeUuidStringRequired

      The root volume UUID.

    • platformStringRequired

      平台。

    • architectureStringRequired

      The architecture type.

    • defaultL3NetworkUuidStringRequired

      No description provided.

    • typeStringRequired

      The VM instance type. Options: UserVm ApplianceVm

    • hypervisorTypeStringRequired

      No description provided.

    • memorySizeLongRequired

      内存大小。

    • cpuNumIntegerRequired

      No description provided.

    • cpuSpeedLongRequired

      No description provided.

    • allocatorStrategyStringRequired

      No description provided.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • stateStringRequired

      The state of the VM instance. Options: Created Starting Running Stopping Stopped Rebooting Destroying Destroyed Migrating Expunging Pausing Paused Resuming VolumeMigrating Unknown

    • guestOsTypeStringRequired

      The Operating System type.

    • vmNicsListRequired

      See vmNics.

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        The IP address.

      • macStringRequired

        The MAC address.

      • hypervisorTypeStringRequired

        The hypervisor type.

      • netmaskStringRequired

        The netmask.

      • gatewayStringRequired

        The gateway.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        The IP version.

      • deviceIdIntegerRequired

        The device ID.

      • typeStringRequired

        The NIC type.

      • usedIpsListRequired

        For more information, see usedIps

        • uuidStringRequired

          The resource UUID.

        • ipRangeUuidStringRequired

          The IP range UUID.

        • l3NetworkUuidStringRequired

          The L3 network UUID.

        • ipVersionIntegerRequired

          The IP version.

        • ipStringRequired

          The IP address.

        • netmaskStringRequired

          The netmask.

        • gatewayStringRequired

          The gateway.

        • usedForStringRequired

          已使用用于。

        • ipInLonglongRequired

          No description provided.

        • vmNicUuidStringRequired

          The VM NIC UUID.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • allVolumesListRequired

      See allVolumes.

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • primaryStorageUuidStringRequired

        The primary storage UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • diskOfferingUuidStringRequired

        The disk offering UUID.

      • rootImageUuidStringRequired

        The root image UUID.

      • installPathStringRequired

        The installation path.

      • typeStringRequired

        The volume type.

      • formatStringRequired

        The volume format.

      • sizeLongRequired

        The volume size.

      • actualSizeLongRequired

        The actual size of the volume.

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        The volume state.

      • statusStringRequired

        The volume status.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • isShareableBooleanRequired

        是否共享云盘

      • volumeQosStringRequired

        The volume QoS, in the format of total=1048576

    • vmCdRomsListRequired

      See vmCdRoms

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • deviceIdIntegerRequired

        The drive sequence number.

      • isoUuidStringRequired

        The ISO image UUID.

      • isoInstallPathStringRequired

        The mount path of the ISO image.

      • nameStringRequired

        The resource name.

      • descriptionString

        Optional. The detailed description of the resource.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

GET/zstack/v1/vm-instances

/zstack/v1/vm-instances

Operation ID

QueryVmInstance

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/vm-instances' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "a43716db0d713c319be06811ebcc00a1", "name": "Test-VM", "description": "web server VM", "zoneUuid": "dfa731eef1f13f1da298855d6ce282bd", "clusterUuid": "743b07830cb6324192a2e0cc34186814", "imageUuid": "ea51c3f89cb53b0db4abdd648c476f80", "hostUuid": "d808c413110a32cab4d9c4d034818eb0", "lastHostUuid": "3da349b211ba3cebb5629c0f90aadf63", "instanceOfferingUuid": "1a3f2ce111cf318688f7bb0cc217d5ff", "rootVolumeUuid": "b677bd698e1d3e4b9787fa81827d13d4", "platform": "Linux", "architecture": "x86_64", "defaultL3NetworkUuid": "3bcc70b465c4371b8a7f9bd975fdec76", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 9:20:57 AM", "lastOpDate": "Nov 14, 2017 9:20:57 AM", "state": "Running", "vmNics": [ { "uuid": "39da5aec41f336929db3458395614151", "vmInstanceUuid": "a43716db0d713c319be06811ebcc00a1", "usedIpUuid": "69008cc8dbd03aeba1787ec024a0b326", "l3NetworkUuid": "3bcc70b465c4371b8a7f9bd975fdec76", "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.0, "createDate": "Nov 14, 2017 9:20:57 AM", "lastOpDate": "Nov 14, 2017 9:20:57 AM" } ], "allVolumes": [ { "uuid": "b677bd698e1d3e4b9787fa81827d13d4", "name": "Root-Volume-For-VM-a43716db0d713c319be06811ebcc00a1", "primaryStorageUuid": "413b0d61df4e3b088f5ee045ff84b65b", "vmInstanceUuid": "a43716db0d713c319be06811ebcc00a1", "diskOfferingUuid": "37c73ea89a2b3a7bb7126f5fe7a32dc6", "rootImageUuid": "ea51c3f89cb53b0db4abdd648c476f80", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b677bd698e1d3e4b9787fa81827d13d4/b677bd698e1d3e4b9787fa81827d13d4.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 9:20:57 AM", "lastOpDate": "Nov 14, 2017 9:20:57 AM" } ], "vmCdRoms": [ { "uuid": "45330c110bf23b08b1e41036d6c6aa6c", "deviceId": 0.0, "isoUuid": "5887742601aa32b5ac57e9024ff38ee8", "name": "cd-1", "description": "desc", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "guestOsType": "CentOS7" } ] }

Change History

This API has no change history records yet.

View all change history