完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。
日志流目标相关操作
列出可流式传输的事件类型
列出可以发送到日志流目标的事件类型。需要 `eventBusDestination:list` 作用域,并获得日志流功能许可。
GET/settings/log-streaming/event-types
响应
| 状态码 | 说明 |
|---|
200 | 操作成功。
|
401 | 未授权
|
403 | 禁止访问
|
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|
data | array | 是 | 可以流式传输到目标的事件名称。
|
下载完整 OpenAPI 定义(JSON)
列出日志流目标
列出已配置的日志流目标。需要 `eventBusDestination:list` 作用域,并获得日志流功能许可。
GET/settings/log-streaming/destinations
响应
| 状态码 | 说明 |
|---|
200 | 操作成功。
|
401 | 未授权
|
403 | 禁止访问
|
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|
data | array | 是 | 已配置的日志流目标。
展开字段结构 1 | 字段 | 类型 | 必填 | 说明 |
|---|
data.[]label | string | 否 | 界面中显示的可读名称。
| data.[]enabled | boolean | 否 | 目标当前是否接收事件。
| data.[]subscribedEvents | array | 否 | 此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
| data.[]anonymizeAuditMessages | boolean | 否 | 发送审计消息负载之前,是否进行匿名化。
| data.[]circuitBreaker | object | 否 | 投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。
| data.[]type | string | 是 | 将每个事件作为 HTTP 请求发送到 URL。
可选值:webhook
| data.[]url | string | 是 | 接收事件负载的目标 URL。
| data.[]method | string | 否 | 请求使用的 HTTP 方法。
| data.[]sendHeaders | boolean | 否 | 是否为请求 附加自定义请求头。
| data.[]specifyHeaders | string | 否 | 自定义请求头的提供方式:keypair 或 json。
| data.[]headerParameters | object | 否 | 相应的 specify* 字段为 keypair 时使用的键值对。
| data.[]jsonHeaders | string | 否 | specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。
| data.[]sendQuery | boolean | 否 | 是否为请求附加查询参数。
| data.[]specifyQuery | string | 否 | 查询参数的提供方式:keypair 或 json。
| data.[]queryParameters | object | 否 | 相应的 specify* 字段为 keypair 时使用的键值对。
| data.[]jsonQuery | string | 否 | specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。
| data.[]options | object | 否 | 附加 HTTP 请求选项。
| data.[]id | string | 是 | 服务器生成的目标唯一 id,响应中返回,请求中不接受。
|
结构 2 | 字段 | 类型 | 必填 | 说明 |
|---|
data.[]label | string | 否 | 界面中显示的可读名称。
| data.[]enabled | boolean | 否 | 目标 当前是否接收事件。
| data.[]subscribedEvents | array | 否 | 此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
| data.[]anonymizeAuditMessages | boolean | 否 | 发送审计消息负载之前,是否进行匿名化。
| data.[]circuitBreaker | object | 否 | 投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。
| data.[]type | string | 是 | 将每个事件发送到 syslog 服务器。
可选值:syslog
| data.[]host | string | 是 | Syslog 服务器主机。
| data.[]port | integer | 否 | Syslog 服务器端口。
| data.[]protocol | string | 否 | 传输协议。
可选值:udp, tcp, tls
| data.[]facility | integer | 否 | Syslog facility 代码(0–23,按 RFC 5424)。常用值:0 Kernel(内核)、1 User(用户)、3 System(系统)、13 Audit(审计)、14 Alert(警报)、16 Local0、17 Local1、18 Local2、19 Local3、20 Local4、21 Local5、22 Local6、23 Local7。
| data.[]app_name | string | 否 | syslog 消息中报告的应用名称。
| data.[]tlsCa | string | 否 | protocol 为 tls 时使用的 PEM 编码 CA 证书。
| data.[]id | string | 是 | 服务器生成的目标唯一 id,响应中返回,请求中不接受。
|
结构 3 | 字段 | 类型 | 必填 | 说明 |
|---|
data.[]label | string | 否 | 界面中显示的可读名称。
| data.[]enabled | boolean | 否 | 目标当前是否接收事件。
| data.[]subscribedEvents | array | 否 | 此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
| data.[]anonymizeAuditMessages | boolean | 否 | 发送审计消息负载之前,是否进行匿名化。
| data.[]circuitBreaker | object | 否 | 投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。
| data.[]type | string | 是 | 将每个事件发送到 Sentry 项目。
可选值:sentry
| data.[]dsn | string | 是 | 接收事件的 Sentry DSN。
| data.[]id | string | 是 | 服务器生成的目标唯一 id,响应中返回,请求中不接受。
|
|
下载完整 OpenAPI 定义(JSON)
创建日志流目标
创建日志流目标。目标使用与界面相同的校验,并以相同方式生效。需要 `eventBusDestination:create` 作用域,并获得日志流功能许可。目标通过环境变量管理时,写入会以 409 拒绝,不创建任何目标;读取仍返回当前值。
POST/settings/log-streaming/destinations
请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。
|
请求体
application/json
结构 1
| 字段 | 类型 | 必填 | 说明 |
|---|
label | string | 否 | 界面中显示的可读名称。
|
enabled | boolean | 否 | 目标当前是否接收事件。
|
subscribedEvents | array | 否 | 此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。
|
anonymizeAuditMessages | boolean | 否 | 发送审计消息负载之前,是否进行匿名化。
|
circuitBreaker | object | 否 | 投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。
展开字段| 字段 | 类型 | 必填 | 说明 |
|---|
circuitBreaker.maxFailures | integer | 否 | 熔断器断开前,滑动窗口内允许的最大失败次数。
| circuitBreaker.failureWindow | integer | 否 | 统计失败次数的滑动窗口,单位为毫秒。
|
|
type | string | 是 | 将每个事件作为 HTTP 请求发送到 URL。
可选值:webhook
|
url | string | 是 | 接收事件负载的目标 URL。
|
method | string | 否 | 请求使用的 HTTP 方法。
|
sendHeaders | boolean | 否 | |