跳转到主要内容
ZStack
资源中心/硬件设施/物理机相关接口/PCI设备相关接口

获取可用的MDEV设备

获取可用的MDEV设备

GET/zstack/v1/mdev-devices/candidates

操作 ID

GetMdevDeviceCandidates

起始版本

3.5.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • clusterUuids
    List

    集群UUID

  • hostUuid
    String

    物理机UUID

  • vmInstanceUuid
    String

    云主机UUID

  • types
    List

    设备类型

  • systemTags
    List

    系统标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • parentUuid
      String必填

      物理PCI设备UUID

    • hostUuid
      String必填

      物理机UUID

    • vmInstanceUuid
      String必填

      云主机UUID

    • mdevSpecUuid
      String必填

      MDEV设备规格UUID

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • type
      MdevDeviceType必填

      详情参考type

      • GPU_Video_Controller
        MdevDeviceType必填

        GPU显卡控制器

    • state
      MdevDeviceState必填

      详情参考state

      • Enabled
        MdevDeviceState必填

        启用

      • Disabled
        MdevDeviceState必填

        停用

    • status
      MdevDeviceStatus必填

      详情参考status

      • Active
        MdevDeviceStatus必填

        就绪

      • Attached
        MdevDeviceStatus必填

        已挂载