跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口/PCI设备相关接口
GETPCI Device Related APIs起始版本 3.5.0同步需要认证

获取可用的MDEV设备

获取可用的MDEV设备

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • clusterUuidsList

    集群UUID

  • hostUuidString

    主机UUID

  • vmInstanceUuidString

    虚拟机UUID

  • typesList

    设备类型

  • systemTagsList

    系统标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • parentUuidString必填

      物理PCI设备UUID

    • hostUuidString必填

      主机UUID

    • vmInstanceUuidString必填

      虚拟机UUID

    • mdevSpecUuidString必填

      MDEV设备规格UUID

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • typeMdevDeviceType必填

      详情参考type

      • GPU_Video_ControllerMdevDeviceType必填

        GPU显卡控制器

    • stateMdevDeviceState必填

      详情参考state

      • EnabledMdevDeviceState必填

        启用

      • DisabledMdevDeviceState必填

        停用

    • statusMdevDeviceStatus必填

      详情参考status

      • ActiveMdevDeviceStatus必填

        就绪

      • AttachedMdevDeviceStatus必填

        已挂载

    • chooserMdevDeviceChooser必填

      详情参考chooser

      • NonePciDeviceChooser必填

        无。

      • DevicePciDeviceChooser必填

        设备。

      • SpecPciDeviceChooser必填

        规格。

请求地址

GET/zstack/v1/mdev-devices/candidates

/zstack/v1/mdev-devices/candidates

操作 ID

GetMdevDeviceCandidates

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/mdev-devices/candidates?clusterUuids=<clusterUuids>&hostUuid=<hostUuid>&vmInstanceUuid=<vmInstanceUuid>&types=<types>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "ff09c7d3eb084e0c92d91f91559b0015", "name": "GRID M60-2A", "parentUuid": "cd35f76c62ec4e0ca5af3f93434f9410", "hostUuid": "55c3da7722a442fcbf5cc2373cb45dc7", "mdevSpecUuid": "55d7980cf5604dd6b45e2946fa75a312", "type": "GPU_Video_Controller", "state": "Enabled", "status": "Active", "chooser": "None", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史