使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。
使用
适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
Content-Type: application/json
HTTP 422 / environment_package_invalid 的错误根含 field、reason(string,均必填),用于定位非法输入。它们是该业务分支的顶层字段,不是所有错误共有的 details 子字段。
保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。
以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。
Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。复用 UI 环境依赖包服务。先向 uploads 以 multipart/form-data 上传单个 file,再用 JSON 元数据及 upload_id 创建或替换。文件非空且不超过 1 GiB;回执绑定组织和上传者,一小时有效、只能消费一次。替换必须提交 expected_revision,保留原 dependency/platform/arch 和 enabled。服务计算大小与 SHA-256;不检测可执行文件兼容性。列表保留 UI 的筛选与分页,不聚合全部页。写入及长上传会重新校验应用当前授权。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|---|---|---|
| 环境依赖包读取(read) | environment-packages | admin.v1.environment-packages.read | qwenwork-biz-service |
公共请求头
适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。
Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
| q | query | string | 否 | 搜索关键词; maxLength=200 | - |
| enabled | query | boolean | 否 | 是否启用 | - |
| dependency | query | string | 否 | 依赖项名称; maxLength=64 | - |
| platform | query | string | 否 | platform; enum=["windows", "macos", "linux"] 取值:"linux"、"macos"、"windows" | - |
| arch | query | string | 否 | arch; enum=["x64", "arm64"] 取值:"arm64"、"x64" | - |
| page | query | integer · int64 | 否 | 页码,从 1 开始; format="int64", minimum=1, maximum=1000000, default=1 default=1 | - |
| page_size | query | integer · int64 | 否 | 每页条数; format="int64", minimum=1, maximum=100, default=20 default=20 | - |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
响应状态表
| HTTP 状态码 | 触发条件 | 响应结构引用 | 客户端处理建议 |
|---|---|---|---|
| 200 | 请求成功 | 见本文“响应结果” | 读取响应结果。 |
| default | 未单独列出的认证、授权、校验或依赖错误 | 见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构 | 按状态与 code 处理;写操作重试前核实结果及幂等要求。 |
响应结果
Content-Type: application/json
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| items | array<object> | null | 是 | 结果列表 | - |
| page | integer · int64 | 是 | 页码,从 1 开始; format="int64" | - |
| page_size | integer · int64 | 是 | 每页条数; format="int64" | - |
| total | integer · int64 | 是 | 符合筛选条件的总记录数; format="int64" | - |
items[]
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| arch | string | 是 | CPU 架构; enum=["x64", "arm64"] 取值:"arm64"、"x64" |
| checksum_sha256 | string | 是 | 文件 SHA-256 摘要 |
| created_at | string · date-time | 是 | 创建时间; format="date-time" |
| dependency | string | 是 | 环境依赖类型; maxLength=64, pattern="^[a-z0-9][a-z0-9._-]{0,63}" |
| enabled | boolean | 是 | 是否启用 |
| file_name | string | 是 | 文件名 |
| id | string | 是 | 记录标识 |
| platform | string | 是 | 目标平台; enum=["windows", "macos", "linux"] 取值:"linux"、"macos"、"windows" |
| revision | integer · int64 | 是 | 当前版本号,用于并发控制; format="int64" |
| size_bytes | integer · int64 | 是 | 文件大小(字节); format="int64" |
| updated_at | string · date-time | 是 | 更新时间; format="date-time" |
| version | string | 是 | 版本 |