Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Route Resource Operations
GETRoute Resource OperationsSince 0.6SynchronousAuth Required

QueryApplianceVm

QueryApplianceVm

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.

    • applianceVmTypeStringRequired

      设备云主机类型。

    • managementNetworkUuidStringRequired

      No description provided.

    • defaultRouteL3NetworkUuidStringRequired

      No description provided.

    • statusStringRequired

      状态信息。

    • agentPortIntegerRequired

      代理端口。

    • 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

      平台。

    • defaultL3NetworkUuidStringRequired

      No description provided.

    • typeStringRequired

      类型。

    • 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

      当前状态。

    • vmNicsListRequired

      See vmNics.

      • uuidStringRequired

        The resource UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        来源IP地址。

      • macStringRequired

        No description provided.

      • netmaskStringRequired

        No description provided.

      • gatewayStringRequired

        No description provided.

      • metaDataStringRequired

        元数据。

      • deviceIdIntegerRequired

        设备ID。

      • 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

        根镜像UUID。

      • installPathStringRequired

        安装路径。

      • typeStringRequired

        类型。

      • formatStringRequired

        数据格式或导出格式。

      • sizeLongRequired

        返回记录数。

      • actualSizeLongRequired

        实际大小。

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        当前状态。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • isShareableBooleanRequired

        是否可分享。

Endpoint

GET/zstack/v1/vm-instances/appliances

/zstack/v1/vm-instances/appliances

Operation ID

QueryApplianceVm

Permalink

Request Example

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

Response Example

200
{ "inventories": [ { "uuid": "f71a399a79794ab8a41e26a601ac7387", "name": "Test-VM", "description": "Appliance VM", "zoneUuid": "4cf173a14e67440c9349c1e236a56c37", "clusterUuid": "07412e72791c474fa240b75da1b210c5", "imageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "hostUuid": "0cbed62c52bc407e994c966f246363bd", "lastHostUuid": "08921382c4f44705bae7cba6414c811d", "instanceOfferingUuid": "e056c84995cb4d68ac78dbcc30af3f4f", "rootVolumeUuid": "2557a6f997ee457fad526e179a76e8c0", "platform": "Linux", "defaultL3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM", "state": "Running", "vmNics": [ { "uuid": "d2dfc67ddf28431bb64cc90fe0e113f6", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "usedIpUuid": "f654374b78534f5fb9b75873084932a3", "l3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "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": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM" } ], "allVolumes": [ { "uuid": "2557a6f997ee457fad526e179a76e8c0", "name": "Root-Volume-For-VM-f71a399a79794ab8a41e26a601ac7387", "primaryStorageUuid": "d00057b39df9494bbaf00d047dd04825", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "diskOfferingUuid": "20346d1b6643492fbc4da8d6baf4b6d2", "rootImageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-2557a6f997ee457fad526e179a76e8c0/2557a6f997ee457fad526e179a76e8c0.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM" } ] } ] }

Change History

This API has no change history records yet.

View all change history