配置活动日志记录

在线编辑

您可以为分析中存储的 API 活动配置日志记录首选项，从而覆盖缺省的活动日志记录行为。

关于本任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息，请参阅 编辑 OpenAPI 3.0 API 定义。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

网关服务器中的每个 API 执行事件都存在一个 API 事件记录。 缺省情况下，成功执行 API 的内容类型为 activity，而 API 的 有效内容 调用会生成错误代码。 编写 API 定义时，可更改要在这些 API 事件记录中记录的 Content-Type。 在 API 执行期间，活动数据存储在 log 上下文变量中，该变量在 API 执行完成时填充 API 事件记录; 有关更多信息，请参阅 API 活动日志记录上下文变量。

注：

用于在成功时调用对分析数据进行记录的活动日志记录不适用于 OAuth 提供者。 OAuth 提供者会记录失败案例的分析数据，但不记录成功案例。

您随时可以通过点击“源代码”图标 OpenAPI 源图标，直接切换到底层的 OpenAPI YAML源代码。 要返回设计表单，请点击 “表单 ”图标 表单图标。

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 2.0 API 定义中所述。
  2. 选择 网关 选项卡，展开 网关和门户网站设置，然后单击 活动日志。
  3. 选择 已启用，然后选择 成功内容 和 错误内容 字段的选项，如下所示:
    表 1. 字段标签和描述
    字段标签 描述
    成功内容 定义操作成功时要记录的 Content-Type。
    • none：指示未发生任何日志记录。
    • activity: 仅记录调用; 仅记录资源 URI。
    • 标题： 记录活动和标题；除了资源URI之外，还会记录 HTTP 标题。
    • 有效内容: 记录活动，标题和有效内容; 记录所有信息，包括在请求中接收或在响应中返回的有效内容。

    缺省值为 activity。
    错误内容 指示发生错误时要记录的内容。
    • none：指示未发生任何日志记录。
    • activity: 仅记录调用; 仅记录资源 URI。
    • 标题： 记录活动和标题；除了资源URI之外，还会记录 HTTP 标题。
    • 有效内容: 记录活动，标题和有效内容; 记录所有信息，包括在请求中接收或在响应中返回的有效内容。

    缺省值为 payload。
    保留的请求头 单击 添加 以指定要保留以用于记录到分析的定制请求头。
    保留的响应头 单击 添加 以指定要保留用于记录到分析的定制响应头。
  4. 单击保存以保存更改。