DescribePeripheralDrivers - 查询外设驱动列表

更新时间:
复制 MD 格式

查询当前账号可见的外设驱动,支持按归属、品牌、设备类型、驱动 ID 和关键词筛选,并分页返回结果。

接口说明

多个筛选条件同时传入时,返回同时满足这些条件的驱动。不传筛选条件时,查询无影官方与当前账号的驱动。使用 PageSize 和 PageNumber 分页;保持筛选条件和 PageSize 不变,逐页增加 PageNumber,返回空列表时停止。示例值用于说明格式,请替换为实际值。

请求示例

以下 JSON 展示逻辑请求参数。公共签名参数由 SDK 或签名组件生成。

查询官方打印机驱动

查询指定品牌下包含关键词的官方打印机驱动,返回第 1 页,每页最多 20 条。

{
  "Action": "DescribePeripheralDrivers",
  "Version": "2020-09-30",
  "OwnerType": "WUYING",
  "Brand": "hp",
  "DeviceType": "printer",
  "Filter": "LaserJet",
  "PageSize": 20,
  "PageNumber": 1
}

按驱动 ID 批量查询

{
  "Action": "DescribePeripheralDrivers",
  "Version": "2020-09-30",
  "DriverIds": [
    "11111111-2222-4333-8444-555555555555",
    "66666666-7777-4888-8999-000000000000"
  ],
  "PageSize": 20,
  "PageNumber": 1
}

直接构造请求参数时,DriverIds 按序号展开:

DriverIds.1=11111111-2222-4333-8444-555555555555
DriverIds.2=66666666-7777-4888-8999-000000000000

使用 SDK 时传入字符串数组,由 SDK 完成编码。

响应示例

以下响应为格式示例,图标 URL 为示意地址。保留字段 MaxResults 和 NextToken 未提供有效值,示例中省略。

查询成功

{
  "RequestId": "00000000-1111-4222-8333-444444444444",
  "Count": 1,
  "DriverInfos": [
    {
      "Id": "11111111-2222-4333-8444-555555555555",
      "Icon": "https://example.com/icons/printer.png",
      "Name": "HP Universal Printing PCL 6",
      "Brand": "hp",
      "DeviceType": "printer",
      "OsType": "Windows",
      "CreateTime": "2026-09-01T10:30:00+08:00",
      "Source": "Wuying",
      "OwnerType": "WUYING"
    }
  ]
}

无匹配结果

{
  "RequestId": "00000000-1111-4222-8333-444444444444",
  "Count": 0,
  "DriverInfos": []
}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

OwnerType

string

否

驱动归属。取值:WUYING,无影官方驱动;CUSTOMER,当前账号的自定义驱动。不传时查询两类驱动。

枚举值:

  • CUSTOMER :

    当前账号的自定义驱动

  • WUYING :

    无影官方驱动

CUSTOMER

Brand

string

否

品牌标识,精确匹配。按实际配置取值,无固定枚举。不传时不限制品牌。示例仅用于说明格式。

hp

DeviceType

string

否

设备类型标识,精确匹配。按实际配置取值,例如 printer 表示打印机。不传时不限制设备类型。

printer

Filter

string

否

搜索关键词。匹配驱动 ID、品牌标识、驱动名称、描述、设备类型或品牌显示名称,任一字段命中即可。支持 % 匹配任意长度字符、_ 匹配单个字符。不传时不进行关键词筛选。

LaserJet

PageSize

integer

否

每页返回条数。取值范围:1~500;默认值:20。

20

PageNumber

integer

否

页码,建议从 1 开始;默认值:1。

1

DriverIds

array

否

驱动 ID 列表。不传或传入空数组时不限制驱动 ID。仅返回当前账号可见且匹配的驱动;未匹配到的 ID 不产生对应记录。

string

否

单个驱动 ID。请使用实际驱动 ID。

11111111-2222-4333-8444-555555555555

MaxResults

integer

否

保留参数,当前不参与查询或分页,请勿传入。请使用 PageSize 设置每页返回条数。示例值 20 仅用于展示整数类型,不是该参数的默认值,也不表示传入后会生效。

20

NextToken

string

否

保留参数,当前不支持使用分页令牌查询,请勿传入。请使用 PageNumber 指定页码。示例值 token-for-format-only 仅用于展示字符串类型,不是可使用的分页令牌。

token-for-format-only

返回参数

名称

类型

描述

示例值

object

查询结果。响应模型未声明字段必须返回,可选信息和保留字段可能为空或不返回。

Count

integer

匹配的驱动总数,不是当前页列表长度。当前页无数据时可能返回 0。

1

DriverInfos

array<object>

当前页的驱动信息列表,无数据时返回空列表。

object

单个外设驱动的信息。

Brand

string

驱动所属品牌。

hp

CreateTime

string

驱动记录创建时间,采用包含时区偏移的 ISO 8601(RFC 3339)格式。时区偏移以返回值为准。时间信息不存在时可能为空或不返回。

2026-09-01T10:30:00+08:00

DeviceType

string

驱动适用的设备类型。

printer

Icon

string

品牌图标 URL。未配置图标时可能为空或不返回。示例为示意地址。

https://example.com/icons/printer.png

Id

string

驱动 ID,可用于后续查询。

11111111-2222-4333-8444-555555555555

Name

string

驱动名称。

HP Universal Printing PCL 6

OsType

string

驱动适用的操作系统,例如 Windows。以实际返回值为准。

Windows

OwnerType

string

驱动归属。取值:WUYING,无影官方驱动;CUSTOMER,当前账号的自定义驱动。

WUYING

Source

string

驱动来源。取值:OpsApp,管理端上传;WuyingHelper,无影助手上传;Wuying,无影来源。无法识别的来源也可能归为 Wuying;区分官方与自定义驱动请使用 OwnerType。

Wuying

MaxResults

integer

保留字段,当前未提供有效返回值,可能不返回。本接口使用 PageSize 和 PageNumber 分页,请勿依赖该字段。示例值 20 仅用于展示整数类型,不代表当前接口实际返回值、默认值或本次查询的分页大小。

20

NextToken

string

保留字段,当前不提供基于令牌的分页能力,可能不返回。请勿依赖该字段继续查询。示例值 token-for-format-only 仅用于展示字符串类型,不是实际返回值或可使用的分页令牌。

token-for-format-only

RequestId

string

请求标识,排查问题时可提供该值。

00000000-1111-4222-8333-444444444444

示例

正常返回示例

JSON格式

{
  "Count": 1,
  "DriverInfos": [
    {
      "Brand": "hp",
      "CreateTime": "2026-09-01T10:30:00+08:00",
      "DeviceType": "printer",
      "Icon": "https://example.com/icons/printer.png",
      "Id": "11111111-2222-4333-8444-555555555555",
      "Name": "HP Universal Printing PCL 6",
      "OsType": "Windows",
      "OwnerType": "WUYING",
      "Source": "Wuying"
    }
  ],
  "MaxResults": 20,
  "NextToken": "token-for-format-only",
  "RequestId": "00000000-1111-4222-8333-444444444444"
}

错误码

HTTP status code

错误码

错误信息

描述

403 NOT_LOGIN You are not logged in or your login token has expired. 您未登录或登录凭证已过期

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。