Skip to main content

设置系统环境变量状态

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

使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。复用 UI 环境变量服务。revision 是整份配置的版本,成功写入后重新读取最新配置;读取失败不撤销已成功的写入。最多 100 个自定义变量,key 最长 64 字符并符合标识符格式,value 最长 4096 字符。系统保留键不可作为自定义键。启用 QWENWORK_USER_SSO_TOKEN 必须显式 risk_confirmed=true。删除使用查询参数 revision。组织身份来自认证,不能由请求指定。

所需权限

所需权限资源Scope资源服务
环境变量管理(manage)environment-variablesadmin.v1.environment-variables.manageqwenwork-biz-service
PATCH /api/openapi/v1/environment-variables/system/{key}/enabled

公共请求头

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

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
keypathstring是环境变量名称; enum=["QWENWORK_CLIENT_NAME", "QWENWORK_CLIENT_ID", "QWENWORK_USER_NAME", "QWENWORK_USER_ACCOUNT", "QWENWORK_USER_EMAIL", "QWENWORK_USER_EMPLOYEE_NUMBER", "QWENWORK_USER_EXTERNAL_ID", "QWENWORK_USER_DEPARTMENT", "QWENWORK_USER_DEPARTMENT_ID", "QWENWORK_USER_DEPARTMENT_EXTERNAL_ID", "QWENWORK_USER_SSO_TOKEN"] 取值:"QWENWORK_CLIENT_ID"、"QWENWORK_CLIENT_NAME"、"QWENWORK_USER_ACCOUNT"、"QWENWORK_USER_DEPARTMENT"、"QWENWORK_USER_DEPARTMENT_EXTERNAL_ID"、"QWENWORK_USER_DEPARTMENT_ID"、"QWENWORK_USER_EMAIL"、"QWENWORK_USER_EMPLOYEE_NUMBER"、"QWENWORK_USER_EXTERNAL_ID"、"QWENWORK_USER_NAME"、"QWENWORK_USER_SSO_TOKEN"-
enabledbodyboolean是是否启用-
revisionbodyinteger · int64是当前版本号,用于并发控制; format="int64", minimum=0-
risk_confirmedbodyboolean否是否已确认风险-

请求示例

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

响应状态表

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

响应结果

Content-Type: application/json
名称类型必填说明示例
changedboolean是是否发生变更-
revisioninteger · int64是当前版本号,用于并发控制; format="int64"-

错误与重试

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