n8n 节点中的错误处理#

正确的错误处理对于创建健壮的 n8n 节点至关重要，它能在出现问题时为用户提供清晰的反馈。n8n 提供了两个专门的错误类来处理节点实现中的不同类型故障：

• NodeApiError：用于 API 相关错误和外部服务故障
• NodeOperationError：用于操作错误、验证失败和配置问题

NodeApiError#

在处理外部 API 调用和 HTTP 请求时使用 NodeApiError。这个错误类专门用于处理 API 响应错误，并提供增强功能来解析和呈现 API 相关故障，例如：

• HTTP 请求失败
• 外部 API 错误
• 认证/授权失败
• 速率限制错误
• 服务不可用错误

使用以下模式初始化新的 NodeApiError 实例：

1

| ``` new NodeApiError(node: INode, errorResponse: JsonObject, options?: NodeApiErrorOptions)

---|---

### 常用使用模式[#](https://docs.n8n.io/integrations/creating-nodes/build/reference/error-handling/#common-usage-patterns "永久链接")
对于基本的 API 请求失败，捕获错误并将其包装在 `NodeApiError` 中：

1 2 3 4 5 6 7 8 9 10

| ```
try {
  const response = await this.helpers.requestWithAuthentication.call(
    this,
    credentialType,
    options
  );
  return response;
} catch (error) {
  throw new NodeApiError(this.getNode(), error as JsonObject);
}

---|---

使用自定义消息处理特定的 HTTP 状态码：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

| ```try { const response = await this.helpers.requestWithAuthentication.call( this, credentialType, options ); return response; } catch (error) { if (error.httpCode === "404") { const resource = this.getNodeParameter("resource", 0) as string; const errorOptions = { message:${ resource.charAt(0).toUpperCase() + resource.slice(1) } not found, description: "The requested resource could not be found. Please check your input parameters.", }; throw new NodeApiError( this.getNode(), error as JsonObject, errorOptions ); }

if (error.httpCode === "401") { throw new NodeApiError(this.getNode(), error as JsonObject, { message: "Authentication failed", description: "Please check your credentials and try again.", }); }

throw new NodeApiError(this.getNode(), error as JsonObject); }

---|---
## NodeOperationError[#](https://docs.n8n.io/integrations/creating-nodes/build/reference/error-handling/#nodeoperationerror "永久链接")
在以下情况下使用 `NodeOperationError`：
  * 操作错误
  * 验证失败
  * 与外部 API 调用无关的配置问题
  * 输入验证错误
  * 缺少必需参数
  * 数据转换错误
  * 工作流逻辑错误

使用以下模式初始化新的 `NodeOperationError` 实例：

1

| ```
newNodeOperationError(node:INode,error:Error|string|JsonObject,options?:NodeOperationErrorOptions)

---|---

常用使用模式#

使用 NodeOperationError 验证用户输入：

1
2
3
4
5
6
7
8
9

| ``` constemail=this.getNodeParameter("email",itemIndex)asstring;

if(email.indexOf("@")===-1){ constdescription=The email address '${email}' in the 'email' field isn't valid; thrownewNodeOperationError(this.getNode(),"Invalid email address",{ description, itemIndex,// 对于多个项目，这将把错误关联到特定项目 }); }

---|---
处理多个项目时，包含项目索引以提供更好的错误上下文：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

| ```
for(leti=0;i<items.length;i++){
try{
// 处理项目
constresult=awaitprocessItem(items[i]);
returnData.push(result);
}catch(error){
if(this.continueOnFail()){
returnData.push({
json:{error:error.message},
pairedItem:{item:i},
});
continue;
}

thrownewNodeOperationError(this.getNode(),errorasError,{
description:error.description,
itemIndex:i,
});
}
}

---|--- 与文档交流 本页面 点赞 有帮助 点踩 没有帮助 感谢您的反馈！ 提交 上一页 代码标准 下一页 版本控制 基于 Material for MkDocs Insiders 构建