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

Query Virtual Machine Device Address Group

Query Virtual Machine Device Address Group

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.

  • successbooleanRequired

    Whether the request is successful

  • inventoriesListRequired

    For details, see inventories

    • uuidStringRequired

      UUID of the resource, uniquely identifying the resource

    • resourceUuidStringRequired

      Resource UUID

    • vmInstanceUuidStringRequired

      Virtual Machine UUID

    • createDateTimestampRequired

      Create time

    • lastOpDateTimestampRequired

      Last modification time

    • addressListListRequired

      For details, see addressList

      • idlongRequired

        资源ID。

      • resourceUuidStringRequired

        Resource UUID

      • vmInstanceUuidStringRequired

        Virtual Machine UUID

      • deviceAddressStringRequired

        Device Address

      • addressGroupUuidStringRequired

        地址组UUID。

      • metadataStringRequired

        附加元数据。

      • metadataClassStringRequired

        元数据类。

      • createDateTimestampRequired

        Create time

      • lastOpDateTimestampRequired

        Last modification time

  • errorErrorCodeRequired

    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

Endpoint

GET/zstack/v1/vmInstance/resource/metadata/group

/zstack/v1/vmInstance/resource/metadata/group

Operation ID

QueryVmInstanceResourceMetadataGroup

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/vmInstance/resource/metadata/group' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "54cf17e0b4be38b59b43abb778c56379", "resourceUuid": "688ee3ed522d33d9a4ec9d3740938972", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM", "addressList": [ { "id": 1, "resourceUuid": "fe925ba7d1a4342a8d86bd57dafe09ef", "vmInstanceUuid": "7534a094abe63aa08ddf8b6d43ed451b", "deviceAddress": "{\"bus\":\"00\",\"domain\":\"0000\",\"slot\":\"0d\",\"function\":\"0\"}", "addressGroupUuid": "54cf17e0b4be38b59b43abb778c56379", "metadata": "{\"uuid\":\"6b493e7c870d362d8dd75bf3cd3a26eb\",\"name\":\"Root-Volume-For-VM-7da78e9e53d9339fb2f034e19cc2e160\",\"primaryStorageUuid\":\"cc2e2c3954233a489648e9df8f90825c\",\"vmInstanceUuid\":\"7da78e9e53d9339fb2f034e19cc2e160\",\"diskOfferingUuid\":\"53a9fea90a9c38899367b0a2c338bc4a\",\"rootImageUuid\":\"6bf5558add1d3f6481940fb0575ce806\",\"installPath\":\"/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-6b493e7c870d362d8dd75bf3cd3a26eb/6b493e7c870d362d8dd75bf3cd3a26eb.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\"}", "metadataClass": "org.zstack.header.vm.devices.VmInstanceResourceMetadataGroupInventory", "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