Skip to main content

查询系统模型

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

使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。模型配置指 BYOK 自定义模型及系统模型查询。创建严格复用 UI 的“测试并保存”:先测试连接,失败不保存,成功保存但不自动启用。models/connection-tests 是独立预检,不保存模型或凭据。保留 BYOK 特性开关、管理开关、上游地址限制和凭据处理;列表保持分页。创建要求 Idempotency-Key。不新增模型修改、删除、启停或密钥轮换。

所需权限

所需权限资源Scope资源服务
模型配置读取(read)modelsadmin.v1.models.readqwenwork-biz-service
GET /api/openapi/v1/models/system

公共请求头

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

请求参数

无请求参数。

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/models/system' \
  --header 'Authorization: Bearer <API_KEY>'

响应状态表

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

响应结果

Content-Type: application/json
名称类型必填说明示例
itemsarray<object>是结果列表-

items[]

字段类型必填说明
configuredobject是本组织保存的覆盖值;可空字段为 null 时没有该覆盖
effectiveobject是应用覆盖后的当前生效值
originalobject是系统模型原始目录值
resource_idstring · uuid是资源 ID; format="uuid"
row_versioninteger · int64是记录版本号; format="int64"
sourcestring是source; enum=["system"] 取值:"system"
updated_atstring · date-time否更新时间; format="date-time"

items[].configured

字段类型必填说明
descriptionstring | null是说明文本
description_i18nobject否按语言键保存的说明
display_namestring | null是显示名称
display_name_i18nobject否各语言的显示名称
enabledboolean | null是是否启用

items[].effective

字段类型必填说明
badgeobject否按语言键保存的模型标签文案
context_configobject是按上下文窗口档位保存的选项
descriptionstring否说明文本
display_namestring是显示名称
enabledboolean是是否启用
price_factornumber · double是计价倍率; format="double"

items[].original

字段类型必填说明
badgeobject否按语言键保存的模型标签文案
context_configobject是按上下文窗口档位保存的选项
description_i18nobject是按语言键保存的说明
display_name_i18nobject是各语言的显示名称
enabledboolean是是否启用
price_factornumber · double是计价倍率; format="double"

items[].effective.context_config{}

字段类型必填说明
is_defaultboolean是是否为默认选项
token_countinteger · int64是上下文窗口 token 数; format="int64"

items[].original.context_config{}

字段类型必填说明
is_defaultboolean是是否为默认选项
token_countinteger · int64是上下文窗口 token 数; format="int64"

错误与重试

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