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资源服务
模型配置管理(manage)modelsadmin.v1.models.manageqwenwork-biz-service
POST /api/openapi/v1/models/connection-tests

公共请求头

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

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
api_keybodystring · password | null否上游模型 API Key; format="password", maxLength=8192-
endpoint_urlbodystring · uri是上游服务地址; format="uri", maxLength=2048-
pass_third_party_user_idbodyboolean否是否传递第三方用户 ID-
protocol_profilebodystring是protocol profile; enum=["openai_chat_completions_v1"] 取值:"openai_chat_completions_v1"-
upstream_modelbodystring是上游模型名称; maxLength=255-

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request POST \
  --url '<BASE_URL>/api/openapi/v1/models/connection-tests' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoint_url": "https://example.com",
  "protocol_profile": "openai_chat_completions_v1",
  "upstream_model": "<upstream_model>"
}'

响应状态表

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

响应结果

Content-Type: application/json
名称类型必填说明示例
codestring是稳定的业务错误码-
resultstring是result; enum=["success", "failed"] 取值:"failed"、"success"-

错误与重试

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