读取连接器访问策略接口

读取组织的连接器执行控制配置,包括全部允许、按规则匹配或全部禁止模式,以及服务地址和命令匹配规则。此配置控制连接器执行,与分配资源给用户的连接器策略组分别管理。

所需权限

所需权限资源Scope资源服务
连接器读取(读取)connectorsadmin.v1.connectors.readqwenwork-biz-service

GET /api/openapi/v1/connector-access-policy

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET --url '<BASE_URL>/api/openapi/v1/connector-access-policy' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
modestring连接器执行控制模式:allow-all 为全部允许,rule-based 为按规则匹配,deny-all 为全部禁止。"allow-all"
revisioninteger · int64当前记录的修订号,后续更新时用于校验并发修改。0
rulesarray<OpenapifacadeConnectorAccessPolicyRule>按顺序配置的连接器服务地址或命令匹配规则。[{"enabled":false,"expression":"<string>","match_object":"endpoint-url","rule_id":"<uuid>"}]
rules[].enabledboolean是否启用这项配置。false
rules[].expressionstring用于匹配所选对象的规则表达式。"<string>"
rules[].match_objectstring匹配对象:endpoint-url 为服务地址,command 为启动命令。"endpoint-url"
rules[].rule_idstring · uuid访问规则的唯一标识。"<uuid>"
updated_atstring · 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 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}