跳到主要内容

完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。

日志流

日志流目标相关操作

列出可流式传输的事件类型 ​

列出可以发送到日志流目标的事件类型。需要 `eventBusDestination:list` 作用域,并获得日志流功能许可。

GET/settings/log-streaming/event-types

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

响应结构:200 · application/json
字段类型必填说明
dataarray是

可以流式传输到目标的事件名称。

下载完整 OpenAPI 定义(JSON)

列出日志流目标 ​

列出已配置的日志流目标。需要 `eventBusDestination:list` 作用域,并获得日志流功能许可。

GET/settings/log-streaming/destinations

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

响应结构:200 · application/json
字段类型必填说明
dataarray是

已配置的日志流目标。

展开字段

结构 1

字段类型必填说明
data.[]labelstring否

界面中显示的可读名称。

data.[]enabledboolean否

目标当前是否接收事件。

data.[]subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

data.[]anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

data.[]circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

data.[]typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

data.[]urlstring是

接收事件负载的目标 URL。

data.[]methodstring否

请求使用的 HTTP 方法。

data.[]sendHeadersboolean否

是否为请求附加自定义请求头。

data.[]specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

data.[]headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

data.[]jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

data.[]sendQueryboolean否

是否为请求附加查询参数。

data.[]specifyQuerystring否

查询参数的提供方式:keypair 或 json。

data.[]queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

data.[]jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

data.[]optionsobject否

附加 HTTP 请求选项。

data.[]idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 2

字段类型必填说明
data.[]labelstring否

界面中显示的可读名称。

data.[]enabledboolean否

目标当前是否接收事件。

data.[]subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

data.[]anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

data.[]circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

data.[]typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

data.[]hoststring是

Syslog 服务器主机。

data.[]portinteger否

Syslog 服务器端口。

data.[]protocolstring否

传输协议。

可选值:udp, tcp, tls

data.[]facilityinteger否

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_namestring否

syslog 消息中报告的应用名称。

data.[]tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

data.[]idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 3

字段类型必填说明
data.[]labelstring否

界面中显示的可读名称。

data.[]enabledboolean否

目标当前是否接收事件。

data.[]subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

data.[]anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

data.[]circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

data.[]typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

data.[]dsnstring是

接收事件的 Sentry DSN。

data.[]idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

下载完整 OpenAPI 定义(JSON)

创建日志流目标 ​

创建日志流目标。目标使用与界面相同的校验,并以相同方式生效。需要 `eventBusDestination:create` 作用域,并获得日志流功能许可。目标通过环境变量管理时,写入会以 409 拒绝,不创建任何目标;读取仍返回当前值。

POST/settings/log-streaming/destinations

请求参数

参数位置类型必填说明
Idempotency-Keyheaderstring否

此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。

请求体

application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

idstring否

服务器生成的目标唯一 id,响应中返回,请求中不接受。

只读。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

idstring否

服务器生成的目标唯一 id,响应中返回,请求中不接受。

只读。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

idstring否

服务器生成的目标唯一 id,响应中返回,请求中不接受。

只读。

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

409

冲突

415

不支持的媒体类型。

422

无法处理的实体

响应结构:200 · application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

下载完整 OpenAPI 定义(JSON)

获取日志流目标 ​

按 id 获取单个日志流目标。需要 `eventBusDestination:read` 作用域,并获得日志流功能许可。

GET/settings/log-streaming/destinations/{destinationId}

请求参数

参数位置类型必填说明
destinationIdpathstring是

日志流目标的 id。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

响应结构:200 · application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

下载完整 OpenAPI 定义(JSON)

更新日志流目标 ​

替换现有日志流目标。更新使用与界面相同的校验,并以相同方式生效。需要 `eventBusDestination:update` 作用域,并获得日志流功能许可。目标通过环境变量管理时,写入会以 409 拒绝,不作任何更改;读取仍返回当前值。

PUT/settings/log-streaming/destinations/{destinationId}

请求参数

参数位置类型必填说明
destinationIdpathstring是

日志流目标的 id。

请求体

application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

415

不支持的媒体类型。

响应结构:200 · application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

下载完整 OpenAPI 定义(JSON)

删除日志流目标 ​

移除日志流目标。需要 `eventBusDestination:delete` 作用域,并获得日志流功能许可。目标通过环境变量管理时,删除会以 409 拒绝,不移除任何目标;读取仍返回当前值。

DELETE/settings/log-streaming/destinations/{destinationId}

请求参数

参数位置类型必填说明
destinationIdpathstring是

日志流目标的 id。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

响应结构:200 · application/json

结构 1

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件作为 HTTP 请求发送到 URL。

可选值:webhook

urlstring是

接收事件负载的目标 URL。

methodstring否

请求使用的 HTTP 方法。

sendHeadersboolean否

是否为请求附加自定义请求头。

specifyHeadersstring否

自定义请求头的提供方式:keypair 或 json。

headerParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
headerParameters.parametersarray是
jsonHeadersstring否

specifyHeaders 为 json 时,以 JSON 字符串提供的自定义请求头。

sendQueryboolean否

是否为请求附加查询参数。

specifyQuerystring否

查询参数的提供方式:keypair 或 json。

queryParametersobject否

相应的 specify* 字段为 keypair 时使用的键值对。

展开字段
字段类型必填说明
queryParameters.parametersarray是
jsonQuerystring否

specifyQuery 为 json 时,以 JSON 字符串提供的查询参数。

optionsobject否

附加 HTTP 请求选项。

展开字段
字段类型必填说明
options.timeoutinteger否

请求超时时长,单位为毫秒。

options.allowUnauthorizedCertsboolean否

接受自签名或其他无效的 TLS 证书。

options.queryParameterArraysstring否

如何将数组值查询参数序列化到查询字符串中。

可选值:indices, brackets, repeat

options.redirectobject否

跟随重定向的行为。

展开字段
字段类型必填说明
options.redirect.redirectobject是
options.proxyobject否

出站代理配置。

展开字段
字段类型必填说明
options.proxy.proxyobject是
options.socketobject否

连接套接字选项。

展开字段
字段类型必填说明
options.socket.keepAliveboolean否

是否保持套接字打开以便复用。

options.socket.maxSocketsinteger否

每个主机同时保持打开的最大套接字数。

options.socket.maxFreeSocketsinteger否

每个主机保持打开的最大空闲套接字数。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 2

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 syslog 服务器。

可选值:syslog

hoststring是

Syslog 服务器主机。

portinteger否

Syslog 服务器端口。

protocolstring否

传输协议。

可选值:udp, tcp, tls

facilityinteger否

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。

app_namestring否

syslog 消息中报告的应用名称。

tlsCastring否

protocol 为 tls 时使用的 PEM 编码 CA 证书。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

结构 3

字段类型必填说明
labelstring否

界面中显示的可读名称。

enabledboolean否

目标当前是否接收事件。

subscribedEventsarray否

此目标接收的事件名称或事件组前缀,例如 n8n.workflow 会匹配所有 n8n.workflow.* 事件。可从 GET /settings/log-streaming/event-types 获取完整的可传输事件名称列表。

anonymizeAuditMessagesboolean否

发送审计消息负载之前,是否进行匿名化。

circuitBreakerobject否

投递熔断器的调节配置。反复失败后,目标会在冷却窗口内停止发送,避免持续请求异常的接收端。所有字段均可选,省略时使用合理的默认值。

展开字段
字段类型必填说明
circuitBreaker.maxFailuresinteger否

熔断器断开前,滑动窗口内允许的最大失败次数。

circuitBreaker.failureWindowinteger否

统计失败次数的滑动窗口,单位为毫秒。

typestring是

将每个事件发送到 Sentry 项目。

可选值:sentry

dsnstring是

接收事件的 Sentry DSN。

idstring是

服务器生成的目标唯一 id,响应中返回,请求中不接受。

下载完整 OpenAPI 定义(JSON)

向日志流目标发送测试消息 ​

向目标发送测试消息,确认其可访问且配置正确。需要 `eventBusDestination:test` 作用域,并获得日志流功能许可。

POST/settings/log-streaming/destinations/{destinationId}/test

请求参数

参数位置类型必填说明
destinationIdpathstring是

日志流目标的 id。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

响应结构:200 · application/json
字段类型必填说明
successboolean是

测试消息是否成功投递到目标。

下载完整 OpenAPI 定义(JSON)

本文为社区中文翻译。查看对应英文原文