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

获取PCI设备规格候选列表

获取PCI设备规格候选列表

GET/zstack/v1/pci-device-specs/candidates

操作 ID

GetPciDeviceSpecCandidates

起始版本

3.5.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • clusterUuids
    List

    集群UUID

  • hostUuid
    String

    物理机UUID

  • vmInstanceUuid
    String

    云主机UUID

  • vmInstanceUuids
    List

    云主机UUID列表

  • types
    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必填

      资源的详细描述

    • vendorId
      String必填

      供应商ID

    • deviceId
      String必填

      设备ID

    • subvendorId
      String必填

      子供应商ID

    • subdeviceId
      String必填

      子设备ID

    • ramSize
      String必填

      显存容量

    • maxPartNum
      Integer必填

      最大切分数量

    • isVirtual
      Boolean必填

      是否虚拟设备

    • romVersion
      String必填

      固件版本

    • romMd5sum
      String必填

      固件MD5

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • type
      PciDeviceType必填

      详情参考type

      • GPU_Video_Controller
        PciDeviceType必填

        GPU显卡控制器

      • GPU_Audio_Controller
        PciDeviceType必填

        GPU声卡控制器

      • GPU_3D_Controller
        PciDeviceType必填

        GPU 3D控制器

      • Moxa_Device
        PciDeviceType必填

        MOXA卡

      • Generic
        PciDeviceType必填

        一般设备

    • state
      PciDeviceSpecState必填

      详情参考state

      • Enabled
        PciDeviceSpecState必填

        启用

      • Disabled
        PciDeviceSpecState必填

        停用