修改组织的连接器执行模式和规则集合。rules 提交更新后保留的全部规则,expected_revision 填写上次读取的 revision,以防覆盖并发修改。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 连接器管理(管理) | connectors | admin.v1.connectors.manage | qwenwork-biz-service |
PATCH /api/openapi/v1/connector-access-policy
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| expected_revision | body | integer · int64 | 必填 | 上次读取该对象时取得的修订号,用于防止覆盖其他调用方的修改。 | 0 |
| mode | body | string | 必填 | 连接器执行控制模式:allow-all 为全部允许,rule-based 为按规则匹配,deny-all 为全部禁止。 | "allow-all" |
| rules | body | array | null | 必填 | 按顺序配置的连接器服务地址或命令匹配规则。 最多项数:1000。 | [{"enabled":false,"expression":"<string>","match_object":"endpoint-url","rule_id":"<uuid>"}] |
| rules[].enabled | body | boolean | 必填 | 是否启用这项配置。 | false |
| rules[].expression | body | string | 必填 | 用于匹配所选对象的规则表达式。 最多字符数:2048。 | "<string>" |
| rules[].match_object | body | string | 必填 | 匹配对象:endpoint-url 为服务地址,command 为启动命令。 | "endpoint-url" |
| rules[].rule_id | body | string · uuid | 否 | 访问规则的唯一标识。 | "<uuid>" |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request PATCH --url '<BASE_URL>/api/openapi/v1/connector-access-policy' --header 'Authorization: Bearer <API_KEY>' --header 'Content-Type: application/json' --data '{ "expected_revision": 0, "mode": "allow-all", "rules": [{"enabled": false,"expression": "<string>","match_object": "endpoint-url","rule_id": "<uuid>"} ]}'
响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| mode | string | 是 | 连接器执行控制模式:allow-all 为全部允许,rule-based 为按规则匹配,deny-all 为全部禁止。 | "allow-all" |
| revision | integer · int64 | 是 | 当前记录的修订号,后续更新时用于校验并发修改。 | 0 |
| rules | array<OpenapifacadeConnectorAccessPolicyRule> | 是 | 按顺序配置的连接器服务地址或命令匹配规则。 | [{"enabled":false,"expression":"<string>","match_object":"endpoint-url","rule_id":"<uuid>"}] |
| rules[].enabled | boolean | 是 | 是否启用这项配置。 | false |
| rules[].expression | string | 是 | 用于匹配所选对象的规则表达式。 | "<string>" |
| rules[].match_object | string | 是 | 匹配对象:endpoint-url 为服务地址,command 为启动命令。 | "endpoint-url" |
| rules[].rule_id | string · uuid | 是 | 访问规则的唯一标识。 | "<uuid>" |
| updated_at | string · date-time | 是 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
{
"mode": "allow-all",
"revision": 0,
"rules": [
{
"enabled": false,
"expression": "<string>",
"match_object": "endpoint-url",
"rule_id": "<uuid>"
}
],
"updated_at": "2026-08-27T10:00:00Z"
}
default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}