500 内部服务器错误 - BadPath

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

问题

客户端应用收到 HTTP 状态代码 500 Internal Server Error, 将错误代码 protocol.http.BadPath 作为对 API 调用的响应。

错误消息

客户端应用将获得以下响应代码:

HTTP/1.1 500 Internal Server Error

此外,您可能还会看到以下错误消息:

{
   "fault":{
      "faultstring":"Invalid request path",
      "detail":{
         "errorcode":"protocol.http.BadPath"
      }
   }
}

可能的原因

如果后端服务器的请求网址(由流变量表示) target.url, 包含以问号 (?) 开头的 path 开头,该正斜杠 (/) 无效。

根据规范 <ph type="x-smartling-placeholder"></ph> RFC 3986,第 3 部分:语法组件和 <ph type="x-smartling-placeholder"></ph> RFC 3986,第 3.3 节:路径

  1. URI 语法 包含以下组成部分:

            foo://example.com:8042/over/there?name=ferret#nose
            \_/   \______________/\_________/ \_________/ \__/
             |            |            |            |       |
          scheme      authority       path        query   fragment
    
  2. path 组件必需,必须以和 始终包含正斜杠 (/)。

因此,如果后端服务器的请求网址包含以path 问号 (?) 而非正斜杠 (/),则 Apigee Edge 返回 500 Internal Server Error 和错误代码 protocol.http.BadPath

例如:如果 target.url 的值为 https://www.mocktarget.apigee.net?json,那么当 “path”以问号开头,因此无效 (?),而不是正斜杠 (/)。

原因 说明 适用的问题排查说明
后端服务器网址 (target.url) 的路径无效 后端服务器网址中的路径部分,由流变量表示 target.url以问号 (?) 开头,而不是以向前开头 正斜线 (/)。 Edge 公有云和私有云用户

常见诊断步骤

使用以下工具/技术之一来诊断此错误:

API 监控

过程 1:使用 API 监控

<ph type="x-smartling-placeholder">

如需使用 API Monitoring 诊断错误,请执行以下操作:

  1. <ph type="x-smartling-placeholder"></ph> 以拥有用户身份登录 Apigee Edge 界面 适当的角色。
  2. 切换到您要在其中调查问题的单位。

  3. 导航至分析 >API 监控 >调查页面。
  4. 选择您观察到错误的具体时间范围。
  5. 根据时间绘制错误代码

    <ph type="x-smartling-placeholder">
  6. 选择错误代码为 protocol.http.BadPath 的单元格,如下所示 如下:

  7. 错误代码 protocol.http.BadPath 的相关信息显示为 如下所示:

  8. 点击查看日志 ,然后展开失败请求对应的行。

  9. 日志窗口中,请注意以下详细信息: <ph type="x-smartling-placeholder">
      </ph>
    • 状态代码500
    • 故障来源target
    • 错误代码protocol.http.BadPath
  10. 如果故障来源target错误代码protocol.http.BadPath,则表示后端服务器网址具有 路径无效。

Trace

步骤 2:使用跟踪工具

<ph type="x-smartling-placeholder">

如需使用跟踪工具诊断错误,请执行以下操作:

  1. 启用跟踪会话,并且 <ph type="x-smartling-placeholder">
      </ph>
    • 等待发生 500 Internal Server Error 错误,或者
    • 如果您可以重现问题,请进行 API 调用以重现问题 500 Internal Server Error
  2. 确保已启用 Show all FlowInfos

  3. 选择其中一个失败请求并检查跟踪记录。
  4. 浏览跟踪记录的不同阶段,并找到失败的位置。
  5. 您会在目标请求流程开始 后的流程中发现该错误。 阶段,如下所示:

  6. 请记下跟踪记录中的错误值:

    错误:请求路径无效

    由于该错误是在目标请求流程开始后由 Apigee Edge 引发的 阶段,则表示后端服务器网址包含无效路径。这会 如果流变量 target.url(表示 使用 Apigee Edge 中的 目标请求流中的政策之一。

  7. 反向研究每个流程中的读取和分配的变量部分 从错误流程进入目标请求流程已开始阶段。
  8. 确定流变量 target.url 所在的政策 更新时间:

    显示 JavaScript 政策更新了流程变量的示例跟踪记录 target.url:

    在上面显示的示例跟踪记录中,记下流变量变量的值 在名为 JS- SetTargetURL 的 JavaScript 政策中,target.url 会更新,如下所示: target.url : https://mocktarget.apigee.net?json

  9. 请注意,target.url 中的值具有以下组成部分:
    • 架构https
    • 授权方mocktarget.apigee.net
    • 路径?json
  10. 由于 path 组件以问号 (?) 开头 而非正斜杠 (/),那么您会收到错误 Invalid request path
  11. 进入跟踪记录中的 AX(记录的 Google Analytics 数据)阶段,然后点击该阶段。
  12. 向下滚动到 Stage Details - Error Headers 部分,并确定 X-Apigee-fault-codeX-Apigee-fault-source 的值,如下所示:

  13. 您将看到 X-Apigee-fault-codeX-Apigee-fault-source 的值 (分别为protocol.http.BadPathtarget ) 表示此错误是因为后端服务器网址的路径无效而引起。

    响应标头
    X-Apigee-fault-code protocol.http.BadPath
    X-Apigee-fault-source target

NGINX

步骤 3:使用 NGINX 访问日志

<ph type="x-smartling-placeholder">

如需使用 NGINX 访问日志诊断错误,请执行以下操作:

  1. 如果您是私有云用户,则可以使用 NGINX 访问日志来确定 有关 HTTP 500 Internal Server Error 的关键信息。
  2. 查看 NGINX 访问日志:

    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

    <ph type="x-smartling-placeholder">
  3. 搜索是否存在任何带有错误代码的 500 错误 protocol.http.BadPath(如果问题发生在 过去),或者是否还有 500 仍失败的任何请求。
  4. 如果您确实在 X-Apigee-fault-code 匹配项中找到了任何 500 错误, protocol.http.BadPath 的值,然后确定 X- Apigee-fault-source。

    NGINX 访问日志中的 500 错误示例

    以上 NGINX 访问日志中的示例条目包含 X-Apigee- fault-code X-Apigee-fault-source:

    标头
    X-Apigee-fault-code protocol.http.BadPath
    X-Apigee-fault-source target

    请注意,X-Apigee-fault-codeX-Apigee-fault-source 的值为 protocol.http.BadPathtarget ,分别表示 导致此错误的原因是后端服务器网址的路径无效

原因:后端服务器网址 (target.url) 的路径无效

诊断

  1. 使用 API 监控、跟踪工具或 NGINX 访问日志确定 500 Internal Server Error错误代码错误来源,具体说明请参阅 常见的诊断步骤
  2. 如果故障代码protocol.http.BadPath,且故障来源target,则表示后端服务器网址具有无效 路径
  3. 后端服务器网址由 Apigee 中的流变量 target.url 表示 Edge。如果您尝试更新后端服务器网址,通常就会发生此错误 (target.url) 使用任意政策动态使用( 代理/共享流),使其具有无效路径

    <ph type="x-smartling-placeholder">
  4. 确定流变量 target.url 是否确实具有无效 path 及其值的来源:

    Trace

    使用跟踪工具

    如果您已捕获此错误的跟踪记录,请按照 使用跟踪工具

    1. 验证 target.url 的路径是否无效(即开头是否无效) 问号 (?) 而非正斜杠 (/)。
    2. 如果是,请找出修改或更新 target.url 包含无效路径。

      显示 JavaScript 政策更新了流程变量的示例跟踪记录 target.url

    3. 在上述跟踪记录示例中,请注意 JavaScript 政策已修改或更新 target.url 的值,使其包含无效路径。
    4. 请注意,target.url 具有以下组件:
      • 架构https
      • 授权方mocktarget.apigee.net
      • 路径?json

      路径以问号 (?) 开头,而不是以正向开头 正斜线 (/) ,因此无效。

    日志

    在日志服务器中使用日志

    1. 如果您没有此错误的跟踪记录(间歇性问题),请检查 您已记录了数据流变量值的相关信息 target.url,使用诸如 <ph type="x-smartling-placeholder"></ph> MessageLogging ServiceCallout 政策。
    2. 如果您有相关日志,请查看并 <ph type="x-smartling-placeholder">
        </ph>
      1. 验证 target.url 的路径是否无效,以及
      2. 看看您能否确定有关修改的政策的信息 target.url,包含无效路径

    API 代理

    查看失败的 API 代理

    如果您没有此错误的跟踪记录或日志,请查看失败的 API 用于确定修改或更新流变量 target.url 的操作 包含无效路径。请检查以下各项:

    • API 代理中的政策
    • 从代理调用的任何共享流
  5. 仔细查看特定策略(例如:AssignMessage 或 JavaScript)修改或 更新流变量 target.url,并确定导致 将 target.url 更新为具有无效路径

    以下是一些示例政策,用于更新流变量 target.url 错误地包含导致此错误的无效路径。

    示例 1

    示例 1:更新 target.url 变量的 JavaScript 政策

    var url = "https://mocktarget.apigee.net?json"
    context.setVariable("target.url", url);
    

    请注意,在上面的示例中,流变量 target.url 已更新 其值“https://mocktarget.apigee.net?json”包含在另一个 变量 url.

    请注意,url 的值包含以下组成部分:

    • 架构https
    • 授权方mocktarget.apigee.net
    • 路径?json

    路径以问号 (?) 而非正斜杠开头 (/)该号码无效。因此,Apigee Edge 500 Internal Server Error,错误代码为 protocol.http.BadPath

    示例 2

    示例 2:更新 target.url 变量的 JavaScript 政策 根据请求标头中的值

    var path = context.getVariable("request.header.Path");
    var url = "https://mocktarget.apigee.net" + path
    context.setVariable("target.url", url);
    

    请注意,在上面的示例中,流变量 target.url 已更新。 将https://mocktarget.apigee.net包含在 变量 url 另一个变量 path 的值, 从 request.header.Path. 检索其值

    如果您有权访问实际请求或跟踪记录,则可以验证实际值 传递给 request.header.Path

    用户发出的请求示例

    curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token> -H "Path: ?user"
    

    在此示例中,标头路径不会作为请求的一部分发送。因此, JavaScript 政策中变量 path 的值为 null

    因此:

    • url = https://mocktarget.apigee.net + path
    • url = https://mocktarget.apigee.net + "?user"
    • target.url = https://mocktarget.apigee.net?user

    请注意,target.url 的值包含以下组成部分:

    • 架构https
    • 授权方mocktarget.apigee.net
    • 路径?user

    路径以问号 (?) 而非正斜杠开头 (/)该号码无效。因此,Apigee Edge 会返回 500 Internal Server Error 及错误代码 protocol.http.BadPath

    示例 3

    示例 3:更新 target.url 变量的 AssignMessage 政策

    <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-SetTargetURL">
        <DisplayName>AM-SetTargetURL</DisplayName>
        <AssignVariable>
             <Name>target.url</Name>
             <Value>https://mocktarget.apigee.net?echo</Value>
        </AssignVariable>
        <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
        <AssignTo createNew="false" transport="http" type="request"/>
    </AssignMessage>
    

    请注意,url 的值包含以下组成部分:

    • 架构https
    • 授权方mocktarget.apigee.net
    • 路径?echo

    同样,在此示例中,路径以问号 (?) 开头 而不是正斜杠 (/),因为后者无效。因此, Apigee Edge 返回 500 Internal Server Error 并显示错误代码 protocol.http.BadPath

分辨率

按照网址规范 <ph type="x-smartling-placeholder"></ph> RFC 3986,第 3 部分:语法组件path 组件为必填项 并且必须始终以 "/" 开头。因此,请按照以下步骤解决此问题:

  1. 确保后端服务器网址(由流变量表示) target.url 始终具有有效路径始终以 正斜线 (/)。 <ph type="x-smartling-placeholder">
      </ph>
    1. 在某些情况下,路径中可能没有资源名称,那么请确保 路径至少包含一个正斜杠 (/)。
    2. 如果您使用任何其他变量来确定数据流变量的值 target.url,然后确保其他变量没有 无效路径
    3. 如果执行任何字符串操作来确定流变量的值 target.url,然后确保字符串的结果或结果 操作没有无效路径
  2. 在上面讨论的示例中,您可以按如下方式解决此问题:

    示例 1

    示例 1:更新 target.url 变量的 JavaScript 政策

    /? 变量 url 来解决此问题,如下所示:

    var url = "https://mocktarget.apigee.net/json"
    context.setVariable("target.url", url);
    

    示例 2

    示例 2:更新 target.url 变量的 JavaScript 政策 根据请求标头中的值

    var path = context.getVariable("request.header.Path");
    var url = "https://mocktarget.apigee.net" + path
    context.setVariable("target.url", url);
    

    确保传递有效的路径,例如 /user 作为请求的一部分 标头 Path 来解决此问题,如下所示:

    示例请求

    curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token> -H "Path: /user"
    

    示例 3

    示例 3:AssignMessage 政策更新 target.url 变量

    在 AssignMessage 政策的 <Value> 元素中添加有效路径。 也就是说,将问号 (?) 替换为 <Value> 元素中的正斜杠 (/) 和 将其设置为 https://mocktarget.apigee.net/echo 以解决此问题,如下所示:

    <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-SetTargetURL">
        <DisplayName>AM-SetTargetURL</DisplayName>
        <AssignVariable>
             <Name>target.url</Name>
             <Value>https://mocktarget.apigee.net/echo</Value>
        </AssignVariable>
        <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
        <AssignTo createNew="false" transport="http" type="request"/>
    </AssignMessage>
    

    规范

    Apigee Edge 希望后端服务器网址中的 path 组件 必须始终以 正斜杠 (/) 开头,如下所示 规范:

    规范
    <ph type="x-smartling-placeholder"></ph> RFC 3986,第 3 部分:语法组件
    <ph type="x-smartling-placeholder"></ph> RFC 3986,第 3.3 节:路径

    如果您仍需要 Apigee 支持团队的任何帮助,请参阅必须收集 诊断信息

    必须收集的诊断信息

    按照上述说明操作后,如果问题依然存在,请收集以下内容 然后联系 Apigee Edge 支持团队

    如果您是公有云用户,请提供以下信息:

    • 组织名称
    • 环境名称
    • API 代理名称
    • 完成用于重现 500 Internal Server Errorcurl 命令(错误代码为 protocol.http.BadPath
    • API 请求的跟踪文件

    如果您是 Private Cloud 用户,请提供以下信息:

    • 观察到失败请求的完整错误消息
    • 环境名称
    • API 代理软件包
    • API 请求的跟踪文件
    • NGINX 访问日志:

      /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

      其中ORGENVPORT# 替换为 实际值。

    • 消息处理器系统日志 /opt/apigee/var/log/edge-message- processor/logs/system.log

    参考

    用户流变量 - 目标