Skip to main content

创建环境依赖包

使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。

使用 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资源服务
环境依赖包管理(manage)environment-packagesadmin.v1.environment-packages.manageqwenwork-biz-service
POST /api/openapi/v1/environment-packages

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。 Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
archbodystring是arch; enum=["x64", "arm64"] 取值:"arm64"、"x64"-
dependencybodystring是依赖项名称; maxLength=64, pattern="^[a-z0-9][a-z0-9._-]{0,63}"pattern="[a−z0−9][a−z0−9.−]{0,63}"pattern="^[a-z0-9][a-z0-9._-]\{0,63\}"-
enabledbodyboolean否是否启用-
expected_revisionbodyinteger · int64否最近一次读取的版本号; format="int64", minimum=1-
platformbodystring是platform; enum=["windows", "macos", "linux"] 取值:"linux"、"macos"、"windows"-
upload_idbodystring是上传会话 ID-
versionbodystring是版本号; maxLength=64-

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request POST \
  --url '<BASE_URL>/api/openapi/v1/environment-packages' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "arch": "x64",
  "dependency": "<dependency>",
  "platform": "windows",
  "upload_id": "<upload_id>",
  "version": "<version>"
}'

响应状态表

HTTP 状态码触发条件响应结构引用客户端处理建议
201请求成功见本文“响应结果”读取响应结果。
default未单独列出的认证、授权、校验或依赖错误见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json
名称类型必填说明示例
archstring是arch; enum=["x64", "arm64"] 取值:"arm64"、"x64"-
checksum_sha256string是文件 SHA-256 校验值-
created_atstring · date-time是创建时间; format="date-time"-
dependencystring是依赖项名称; maxLength=64, pattern="^[a-z0-9][a-z0-9._-]{0,63}"pattern="[a−z0−9][a−z0−9.−]{0,63}"pattern="^[a-z0-9][a-z0-9._-]\{0,63\}"-
enabledboolean是是否启用-
file_namestring是文件名称-
idstring是记录 ID-
platformstring是platform; enum=["windows", "macos", "linux"] 取值:"linux"、"macos"、"windows"-
revisioninteger · int64是当前版本号,用于并发控制; format="int64"-
size_bytesinteger · int64是文件大小,单位为字节; format="int64"-
updated_atstring · date-time是更新时间; format="date-time"-
versionstring是版本号-

运行时限制与协议说明

HTTP 422 / environment_package_invalid 的错误根含 field、reason(string,均必填),用于定位非法输入。它们是该业务分支的顶层字段,不是所有错误共有的 details 子字段。

错误与重试

保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。 以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。