Skip to main content

查询 Hooks 规则接口

读取组织已保存的 Hook 配置，查看事件、配置数组及启用状态。此管理接口返回保存的配置，不执行其中的脚本或命令。

  • Scope：admin.v1.hooks.read
  • 权限项：Hooks 规则读取（hooks）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/hook-policies

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/hook-policies?page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是记录列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
total_itemsinteger · int64是总条数0
total_pagesinteger · int64是总页数0

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
configany是规则配置；Hook 配置数组，元素原样保存，服务端不解释子字段
created_atstring · date-time是创建时间
descriptionstring是策略说明
enabledboolean是启用状态
event_namestring是触发时机
idstring是策略组 ID
namestring是策略组名称
updated_atstring · date-time是更新时间

items[].config[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
[]any否元素可为任意 JSON 值；服务端只校验顶层为数组，不定义固定子字段
{
  "items": [
    {
      "config": [],
      "created_at": "2026-08-27T10:00:00Z",
      "description": "<string>",
      "enabled": false,
      "event_name": "<string>",
      "id": "<string>",
      "name": "<string>",
      "updated_at": "2026-08-27T10:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_items": 0,
  "total_pages": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}