Skip to main content
Compute Management/VM Related Interfaces
GETVM Related InterfacesSince 0.6SynchronousAuth Required

Get Data Volume Attachable VM

Get Data Volume Attachable VM

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • volumeUuidStringRequired

    Disk UUID

Query Parameters

  • systemTagsList

    System Tag

  • userTagsList

    User Tag

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. When the operation is successful, this field is null. For details, see error

    • codeStringRequired

      Error code number, globally unique identifier of the error, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, default is null

    • opaqueLinkedHashMapRequired

      Reserved field, default is null

    • causeErrorCodeRequired

      Root cause: the source error that triggered the current error. If there is no original error, this field is null

  • inventoriesListRequired

    For details, see inventories

    • uuidStringRequired

      UUID of the resource, uniquely identifying the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Detailed description of the resource

    • zoneUuidStringRequired

      Data Center UUID

    • clusterUuidStringRequired

      Cluster UUID

    • imageUuidStringRequired

      Image UUID

    • hostUuidStringRequired

      Host UUID

    • lastHostUuidStringRequired

      Last Host UUID

    • instanceOfferingUuidStringRequired

      Instance Offering UUID, deprecated

    • rootVolumeUuidStringRequired

      Root Disk UUID

    • platformStringRequired

      Virtual Machine platform type, Windows / Linux / Other

    • architectureStringRequired

      Virtual Machine architecture, x86_64 / aarch64 / Other

    • defaultL3NetworkUuidStringRequired

      Default Distributed Port Group UUID

    • typeStringRequired

      Virtual Machine type, User VM or platform special purpose VM

    • hypervisorTypeStringRequired

      Virtual Machine hypervisor type, typically KVM

    • memorySizeLongRequired

      Memory size

    • cpuNumIntegerRequired

      CPU number

    • cpuSpeedLongRequired

      CPU speed

    • allocatorStrategyStringRequired

      Virtual Machine allocation strategy

    • createDateTimestampRequired

      Create time

    • lastOpDateTimestampRequired

      Last modification time

    • stateStringRequired

      Virtual Machine enabled state

    • guestOsTypeStringRequired

      Virtual Machine host operating system type

    • vmNicsListRequired

      For details, see vmNics

      • uuidStringRequired

        UUID of the resource, uniquely identifying the resource

      • vmInstanceUuidStringRequired

        Virtual Machine 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

        Create time

      • lastOpDateTimestampRequired

        Last modification time

      • usedIpsListRequired

        For details, see usedIps

        • uuidStringRequired

          UUID of the resource, uniquely identifying 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

          Long stored IP address, only valid for ipv4

        • vmNicUuidStringRequired

          Virtual Machine NIC UUID

        • createDateTimestampRequired

          Create time

        • lastOpDateTimestampRequired

          Last modification time

    • allVolumesListRequired

      For details, see allVolumes

      • uuidStringRequired

        UUID of the resource, uniquely identifying the resource

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • primaryStorageUuidStringRequired

        Data Storage UUID

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • diskOfferingUuidStringRequired

        Disk Offering UUID

      • rootImageUuidStringRequired

        根镜像UUID。

      • installPathStringRequired

        安装路径。

      • typeStringRequired

        类型。

      • formatStringRequired

        数据格式或导出格式。

      • sizeLongRequired

        返回记录数。

      • actualSizeLongRequired

        实际大小。

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        当前状态。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        Create time

      • lastOpDateTimestampRequired

        Last modification time

      • isShareableBooleanRequired

        是否可分享。

      • volumeQosStringRequired

        No description provided.

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      For details, see vmCdRoms

      • uuidStringRequired

        UUID of the resource, uniquely identifying the resource

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • deviceIdIntegerRequired

        设备ID。

      • isoUuidStringRequired

        No description provided.

      • isoInstallPathStringRequired

        iso安装路径。

      • nameStringRequired

        Resource name

      • descriptionStringRequired

        Detailed description of the resource

      • createDateTimestampRequired

        Create time

      • lastOpDateTimestampRequired

        Last modification time

Endpoint

GET/zstack/v1/volumes/{volumeUuid}/candidate-vm-instances

/zstack/v1/volumes/{volumeUuid}/candidate-vm-instances

Operation ID

GetDataVolumeAttachableVm

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/volumes/{volumeUuid}/candidate-vm-instances?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "bf72fb9469a33da5ad1c8974635b3064", "name": "Test-VM", "description": "web server VM", "zoneUuid": "b9c2149d168438afb1d2186fc12464bb", "clusterUuid": "eabd65e18e70330f8938f2b5c70fe745", "imageUuid": "be2ac9b13ca633f0a67bcc649523f964", "hostUuid": "3563ced5d39b3353b06c96c302a80df4", "lastHostUuid": "01e07135ba293c4aac03ca48aaf9ae7d", "instanceOfferingUuid": "87e5f856f19131a385ef056a9115ef49", "rootVolumeUuid": "4e62926dd5493df5be4fe39631c29fa2", "platform": "Linux", "defaultL3NetworkUuid": "4a1779bb39f93b5c97054fa862b02e7b", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8589934592, "cpuNum": 1, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM", "state": "Running", "vmNics": [ { "uuid": "0800827948803d9db97f8175f596a6fa", "vmInstanceUuid": "bf72fb9469a33da5ad1c8974635b3064", "usedIpUuid": "a79bcd1711f131cb9df691820514cf5b", "l3NetworkUuid": "4a1779bb39f93b5c97054fa862b02e7b", "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, "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ], "allVolumes": [ { "uuid": "4e62926dd5493df5be4fe39631c29fa2", "name": "Root-Volume-For-VM-bf72fb9469a33da5ad1c8974635b3064", "primaryStorageUuid": "baaf4f9809d633229c60b7197536ad3e", "vmInstanceUuid": "bf72fb9469a33da5ad1c8974635b3064", "diskOfferingUuid": "8d7b24886e1339e69fbc6eec2766c5f8", "rootImageUuid": "be2ac9b13ca633f0a67bcc649523f964", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-4e62926dd5493df5be4fe39631c29fa2/4e62926dd5493df5be4fe39631c29fa2.qcow2", "type": "Root", "format": "qcow2", "size": 107374182400, "actualSize": 21474836480, "deviceId": 0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ] } ] }

Change History

This API has no change history records yet.

View all change history