Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/Volume Operations
GETVolume OperationsSince 0.6SynchronousAuth Required

GetDataVolumeAttachableVm

GetDataVolumeAttachableVm

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

    The volume UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

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

      平台。

    • 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/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": "237e1c010bed43288f2f158cd3b1e218", "name": "Test-VM", "description": "web server VM", "zoneUuid": "4537a02725fd49adb8815887fe95e38d", "clusterUuid": "fe33a5b88c054e94b13a8914086e50f3", "imageUuid": "5bed7e1839c44b4289f0eab2af35681d", "hostUuid": "0242f2a240564fd5bdf84bf651740129", "lastHostUuid": "649a873867a247b1bed6b96b61b2e19a", "instanceOfferingUuid": "1edf7842c7f34e00b48d3899d14a1ff2", "rootVolumeUuid": "2adc2350eb16479aa7b9dfdb9bc82d6a", "platform": "Linux", "defaultL3NetworkUuid": "7119ed6d54ca4624aa8e362d07b03a35", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Jun 7, 2017 9:20:15 PM", "lastOpDate": "Jun 7, 2017 9:20:15 PM", "state": "Running", "vmNics": [ { "uuid": "f967eee9618c4ee3a8cda348b333ba21", "vmInstanceUuid": "237e1c010bed43288f2f158cd3b1e218", "usedIpUuid": "ead7ed9822e64f18b2f926cb71e0b9da", "l3NetworkUuid": "7119ed6d54ca4624aa8e362d07b03a35", "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:15 PM", "lastOpDate": "Jun 7, 2017 9:20:15 PM" } ], "allVolumes": [ { "uuid": "2adc2350eb16479aa7b9dfdb9bc82d6a", "name": "Root-Volume-For-VM-237e1c010bed43288f2f158cd3b1e218", "primaryStorageUuid": "bdffc9aef10d48e4b028d26b09df2e35", "vmInstanceUuid": "237e1c010bed43288f2f158cd3b1e218", "diskOfferingUuid": "0319566f3f7647dbb3a8e642b05f4bfe", "rootImageUuid": "5bed7e1839c44b4289f0eab2af35681d", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-2adc2350eb16479aa7b9dfdb9bc82d6a/2adc2350eb16479aa7b9dfdb9bc82d6a.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:15 PM", "lastOpDate": "Jun 7, 2017 9:20:15 PM" } ] } ] }

Change History

This API has no change history records yet.

View all change history