Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/GPU Device Operations
GETGPU Device OperationsSince 5.1.8SynchronousAuth Required

QueryGpuDevice

QueryGpuDevice

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

    操作是否成功。

  • 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 detailed description of the resource.

    • 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.

    • serialNumberStringRequired

      The serial number.

    • memoryStringRequired

      The GPU memory.

    • powerStringRequired

      The GPU power consumption.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The resource description.

    • hostUuidStringRequired

      The host UUID.

    • parentUuidStringRequired

      父级资源UUID。

    • vmInstanceUuidStringRequired

      The VM instance UUID.

    • pciSpecUuidStringRequired

      No description provided.

    • vendorIdStringRequired

      No description provided.

    • vendorStringRequired

      No description provided.

    • deviceIdStringRequired

      设备ID。

    • deviceStringRequired

      设备。

    • subvendorIdStringRequired

      No description provided.

    • subdeviceIdStringRequired

      No description provided.

    • pciDeviceAddressStringRequired

      No description provided.

    • iommuGroupStringRequired

      No description provided.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • typePciDeviceTypeRequired

      See type.

      • GPU_Video_ControllerPciDeviceTypeRequired

        The GPU video controller.

      • GPU_Audio_ControllerPciDeviceTypeRequired

        The GPU audio controller.

      • GPU_3D_ControllerPciDeviceTypeRequired

        The GPU 3D controller.

      • Moxa_DevicePciDeviceTypeRequired

        The MOXA device.

      • GenericPciDeviceTypeRequired

        The generic devices.

    • statePciDeviceStateRequired

      See state.

      • EnabledPciDeviceStateRequired

        The device is enabled.

      • DisabledPciDeviceStateRequired

        The device is disabled.

    • statusPciDeviceStatusRequired

      See status.

      • ActivePciDeviceStatusRequired

        The device is active.

      • AttachedPciDeviceStatusRequired

        The device is attached.

      • SystemPciDeviceStatusRequired

        The system.

    • virtStatusPciDeviceVirtStatusRequired

      See virStatus.

    • chooserPciDeviceChooserRequired

      See chooser.

      • NonePciDeviceChooserRequired

        无。

      • DevicePciDeviceChooserRequired

        设备。

      • SpecPciDeviceChooserRequired

        规格。

    • metaDataPciDeviceMetaDataRequired

      See metaData.

      • metaDataStringRequired

        元数据。

      • metaDataEntriesListRequired

        See metaDataEntries.

        • keyStringRequired

          The key.

        • valueStringRequired

          The value.

        • opPciDeviceMetaDataOperatorRequired

          See op.

          • EqualPciDeviceMetaDataOperatorRequired

            Equal.

          • UnequalPciDeviceMetaDataOperatorRequired

            Unequal.

    • matchedPciDeviceOfferingRefListRequired

      See matchedPciDeviceOfferingRef.

      • pciDeviceUuidStringRequired

        No description provided.

      • pciDeviceOfferingUuidStringRequired

        No description provided.

    • mdevSpecRefsListRequired

      See mdevSpecRefs.

      • pciDeviceUuidStringRequired

        The PCI device UUID.

      • mdevSpecUuidStringRequired

        The MDEV device offering UUID.

      • effectiveBooleanRequired

        Whether the MDEV offering is used for the PCI device virtualization.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

GET/zstack/v1/gpu-device/gpu-devices

/zstack/v1/gpu-device/gpu-devices

Operation ID

QueryGpuDevice

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/gpu-device/gpu-devices' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ {} ] }

Change History

This API has no change history records yet.

View all change history