Edge Microgate 操作和配置参考

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。
info

Edge Microgateway v. 2.3.x

概览

本主题讨论如何管理和配置 Edge Microgateway,包括监控、日志记录和调试。

更改配置

您需要了解的配置文件包括:

  • 默认系统配置文件
  • 新初始化的 Edge Microgateway 实例的默认配置文件
  • 用于运行实例的动态配置文件

本部分将讨论这些文件以及您在更改这些文件时需要了解的事项。如需详细了解配置文件设置,请参阅 Edge Microgateway 配置参考文档。

默认系统配置文件

安装 Edge Microgateway 时,默认系统配置文件会放置在以下位置:

[prefix]/lib/node_modules/edgemicro/config/default.yaml

其中,[prefix] 是 npm 前缀目录。 请参阅在哪里安装 Edge Microgateway。

如果您更改了系统配置文件,则必须重新初始化、重新配置和重启 Edge Microgateway:

  1. 拨打 edgemicro init
  2. 拨打 edgemicro configure [params]
  3. 拨打 edgemicro start [params]

新初始化的 Edge Microgateway 实例的默认配置文件

运行 edgemicro init 时,系统配置文件(如上所述) default.yaml 会放置在以下目录中:~/.edgemicro

如果您更改 ~/.edgemicro 中的配置文件,则必须重新配置并重启 Edge Microgateway:

  1. edgemicro stop
  2. edgemicro configure [params]
  3. edgemicro start [params]

用于运行实例的动态配置文件

运行 edgemicro configure [params] 时,系统会在 ~/.edgemicro 中创建一个动态配置文件。该文件根据以下模式命名:[org]-[env]-config.yaml,其中 org 和 env 是您的 Apigee Edge 组织和环境名称。您可以使用此文件进行配置更改,然后在零停机时间的情况下重新加载这些更改。例如,如果您添加并配置了插件,则可以重新加载配置,而不会产生任何停机时间,如下所述。

如果 Edge Microgateway 正在运行(零停机时间选项):

  1. 重新加载 Edge Microgateway 配置:
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    其中:

    • org 是您的 Edge 组织名称(您必须是组织管理员)。
    • env 是组织中的环境(例如 test 或 prod)。
    • key 是之前由 configure 命令返回的密钥。
    • secret 是之前由 configure 命令返回的密钥。

    示例

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

如果 Edge Microgateway 已停止:

  1. 重启 Edge Microgateway:
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    其中:

    • org 是您的 Edge 组织名称(您必须是组织管理员)。
    • env 是组织中的环境(例如 test 或 prod)。
    • key 是之前由 configure 命令返回的密钥。
    • secret 是之前由 configure 命令返回的密钥。

    示例

    edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

以下是一个示例配置文件。如需详细了解配置文件设置,请参阅 Edge Microgateway 配置参考文档。

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

设置环境变量

需要 Edge 组织和环境的值以及启动 Edge Microgateway 所需的密钥和 Secret 的命令行界面命令可以存储在以下环境变量中:

  • EDGEMICRO_ORG
  • EDGEMICRO_ENV
  • EDGEMICRO_KEY
  • EDGEMICRO_SECRET

设置这些变量是可选操作。如果您设置了这些变量,则在使用命令行界面 (CLI) 配置和启动 Edge Microgateway 时,无需指定它们的值。

在 Edge Microgateway 服务器上配置 SSL

您可以将 Microgateway 服务器配置为使用 SSL。例如,配置 SSL 后,您可以通过 Edge Microgateway 使用“https”协议调用 API,如下所示:

https://localhost:8000/myapi

如需在 Microgateway 服务器上配置 SSL,请按照以下步骤操作:

  1. 使用 openssl 实用程序或您喜欢的任何方法生成或获取 SSL 证书和密钥。
  2. 将 edgemicro:ssl 属性添加到 Edge Microgateway 配置文件中。如需查看完整的选项列表,请参阅下表。如需详细了解如何修改 Edge Microgateway 配置,请参阅更改配置。例如:
     edgemicro:
         ssl:
             key: <absolute path to the SSL key file>
             cert: <absolute path to the SSL cert file>
             passphrase: admin123 #option added in v2.2.2
             rejectUnauthorized: true #option added in v2.2.2
  3. 重启 Edge Microgateway。按照进行配置更改中概述的步骤操作,具体取决于您修改的配置文件:默认文件或运行时配置文件。

以下是配置了 SSL 的配置文件的 edgemicro 部分示例:

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

下面列出了所有受支持的服务器选项:

选项 说明
key ca.key 文件的路径(采用 PEM 格式)。
cert ca.cert 文件的路径(采用 PEM 格式)。
pfx 包含 PFX 格式的客户端私钥、证书和 CA 证书的 pfx 文件的路径。
passphrase 包含私钥或 PFX 口令的字符串。
ca 包含 PEM 格式的受信任证书列表的文件的路径。
ciphers 描述要使用的密码的字符串,以“:”分隔。
rejectUnauthorized 如果为 true,则系统会根据提供的 CA 列表验证服务器证书。如果验证失败,则会返回错误。
secureProtocol 要使用的 SSL 方法。例如,SSLv3_method 用于强制将 SSL 设为版本 3。
servername SNI(服务器名称指示)TLS 扩展程序的服务器名称。

使用客户端 SSL/TLS 选项

您可以将 Edge Microgateway 配置为在连接到目标端点时充当 TLS 或 SSL 客户端。在 Microgateway 配置文件中,使用 targets 元素设置 SSL/TLS 选项。

此示例提供了将应用于所有主机的设置:

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

在此示例中,设置仅应用于指定的主机:

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

以下是 TLS 的示例:

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

下面列出了所有受支持的客户端选项:

选项 说明
pfx 包含 PFX 格式的客户端私钥、证书和 CA 证书的 pfx 文件的路径。
key ca.key 文件的路径(采用 PEM 格式)。
passphrase 包含私钥或 PFX 口令的字符串。
cert ca.cert 文件的路径(采用 PEM 格式)。
ca 包含 PEM 格式的受信任证书列表的文件的路径。
ciphers 描述要使用的密码的字符串,以“:”分隔。
rejectUnauthorized 如果为 true,则系统会根据提供的 CA 列表验证服务器证书。如果验证失败,则会返回错误。
secureProtocol 要使用的 SSL 方法。例如,SSLv3_method 用于强制将 SSL 设为版本 3。
servername SNI(服务器名称指示)TLS 扩展程序的服务器名称。

使用自定义身份验证服务

默认情况下,Edge Microgateway 使用部署在 Apigee Edge 上的代理进行 OAuth2 身份验证。此代理会在您首次运行 edgemicro configure 时部署。默认情况下,此代理的网址在 Edge Microgateway 配置文件中指定,如下所示:

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

如果您想使用自己的自定义服务来处理身份验证,请将配置文件中的 authUri 值更改为指向您的服务。例如,您可能有一项使用 LDAP 验证身份的服务。

管理日志文件

Edge Microgateway 会记录每个请求和响应的相关信息。日志文件可提供有助于调试和问题排查的信息。

日志文件的存储位置

默认情况下,日志文件存储在 /var/tmp 中。

如何更改默认日志文件目录

存储日志文件的目录在 Edge Microgateway 配置文件中指定。如需详细了解如何更改配置,请参阅更改配置。

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

更改 dir 值以指定其他日志文件目录。

将日志发送到控制台

您可以配置日志记录,以便将日志信息发送到标准输出,而不是发送到日志文件。将 to_console 标志设置为 true,如下所示:

edgemicro:
  logging:
    to_console: true  

采用此设置后,日志将发送到标准输出。目前,您无法同时将日志发送到 stdout 和日志文件。

如何设置日志记录级别

您可以设置以下日志级别:info、warn 和 error。建议使用 info 级别。它会记录所有 API 请求和响应,并且是默认设置。

如何更改日志记录间隔

您可以在 Edge Microgateway 配置文件中配置这些间隔。如需详细了解如何更改配置,请参阅更改配置。

可配置的属性包括:

  • stats_log_interval:(默认:60)将统计信息记录写入 API 日志文件的时间间隔(以秒为单位)。
  • rotate_interval:(默认:24)日志文件轮替的时间间隔(以小时为单位)。例如:
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

注意:归档的日志文件不会被压缩。时间间隔开始时,系统会创建一个带有新时间戳的新日志文件。

良好的日志文件维护做法

随着日志文件数据不断累积,Apigee 建议您采用以下做法:

  • 由于日志文件可能会变得非常大,因此请确保日志文件目录有足够的空间。请参阅以下部分:日志文件的存储位置和如何更改默认日志文件目录。
  • 每周至少删除一次日志文件,或将其移至单独的归档目录。
  • 如果您的政策是删除日志,则可以使用 CLI 命令 edgemicro log -c 移除(清理)旧日志。

日志文件命名惯例

每个 Edge Microgateway 实例都会生成三种类型的日志文件:

  • api - 记录流经 Edge Microgateway 的所有请求和响应。API 计数器(统计信息)和错误也会记录到此文件中。
  • err - 记录发送到 stderr 的所有内容。
  • out - 记录发送到 stdout 的所有内容。

采用的命名规范为:

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

例如:

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

关于日志文件内容

添加时间:v2.3.3

默认情况下,日志记录服务会省略下载的代理、产品和 JSON Web 令牌 (JWT) 的 JSON。如果您希望将这些对象输出到日志文件,请在启动 Edge Microgateway 时设置 DEBUG=*。例如:

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

“api”日志文件的内容

“api”日志文件包含有关通过 Edge Microgateway 的请求和响应流的详细信息。“api”日志文件的命名方式如下:

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

对于向 Edge Microgateway 发出的每个请求,“api”日志文件中会捕获四个事件:

  • 来自客户端的传入请求
  • 向目标发出的传出请求
  • 来自目标的传入响应
  • 向客户端发出的响应

每个单独的条目都以简写形式表示,以使日志文件更加紧凑。以下是代表这四个事件的四个示例条目。在日志文件中,它们如下所示(行号仅供在文档中参考,不会显示在日志文件中)。

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

我们来逐一了解:

1. 来自客户端的传入请求示例:

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
  • 1436403888651 - Unix 日期戳
  • info - 取决于上下文。可以是 info、warn 或 error,具体取决于日志级别。可以是 stats(表示统计信息记录)、warn(表示警告)或 error(表示错误)。
  • req - 标识事件。在这种情况下,请向客户提出请求。
  • m - 请求中使用的 HTTP 动词。
  • u - 网址中基础路径后面的部分。
  • h - Edge Microgateway 监听的主机和端口号。
  • r - 客户端请求源自的远程主机和端口。
  • i - 请求 ID。所有四个事件条目都将共享此 ID。系统会为每个请求分配一个唯一的请求 ID。按请求 ID 关联日志记录可以提供有关目标延迟时间的宝贵数据洞见。
  • d - 自 Edge Microgateway 收到请求以来的时长(以毫秒为单位)。在上面的示例中,目标对请求 0 的响应在 7 毫秒后收到(第 3 行),并在另外 4 毫秒后发送到客户端(第 4 行)。换句话说,总请求延迟时间为 11 毫秒,其中目标花费了 7 毫秒,Edge Microgateway 本身花费了 4 毫秒。

2. 向目标发出的传出请求示例:

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
  • 1436403888651 - Unix 日期戳
  • info - 取决于上下文。可以是 info、warn 或 error,具体取决于日志级别。可以是 stats(表示统计信息记录)、warn(表示警告)或 error(表示错误)。
  • treq - 标识事件。在本例中,目标请求。
  • m - 目标请求中使用的 HTTP 动词。
  • u - 网址中基础路径后面的部分。
  • h - 后端目标的主机和端口号。
  • i - 日志条目的 ID。所有四个事件条目都将共享此 ID。

3. 来自目标的传入响应示例

1436403888672 info tres s=200, d=7, i=0

1436403888651 - Unix 日期戳

  • info - 取决于上下文。可以是 info、warn 或 error,具体取决于日志级别。可以是 stats(表示统计信息记录)、warn(表示警告)或 error(表示错误)。
  • tres - 标识事件。在本例中,目标响应。
  • s - HTTP 响应状态。
  • d - 时长(以毫秒为单位)。目标进行 API 调用所用的时间。
  • i - 日志条目的 ID。所有四个事件条目都将共享此 ID。

4. 向客户端发出的响应示例

1436403888676 info res s=200, d=11, i=0

1436403888651 - Unix 日期戳

  • info - 取决于上下文。可以是 info、warn 或 error,具体取决于日志级别。可以是 stats(表示统计信息记录)、warn(表示警告)或 error(表示错误)。
  • res - 标识事件。在这种情况下,请回复客户端。
  • s - HTTP 响应状态。
  • d - 时长(以毫秒为单位)。这是 API 调用所花费的总时间,包括目标 API 所花费的时间以及 Edge Microgateway 本身所花费的时间。
  • i - 日志条目的 ID。所有四个事件条目都将共享此 ID。

日志文件时间安排

日志文件会按照 rotate_interval 配置属性指定的间隔进行轮替。系统会继续向同一日志文件添加条目,直到轮替间隔到期。但是,每次重启 Edge Microgateway 时,它都会收到一个新的 UID,并使用此 UID 创建一组新的日志文件。另请参阅良好的日志文件维护做法。

Edge Microgateway 配置参考

配置文件的位置

本部分中介绍的配置属性位于 Edge Microgateway 配置文件中。如需详细了解如何更改配置,请参阅更改配置。

edge_config 属性

这些设置用于配置 Edge Microgateway 实例与 Apigee Edge 之间的交互。

  • bootstrap:(默认:无)指向在 Apigee Edge 上运行的 Edge Microgateway 专用服务的网址。Edge Microgateway 使用此服务与 Apigee Edge 通信。当您执行命令以生成公钥/私钥对 edgemicro genkeys 时,系统会返回此网址。如需了解详情,请参阅设置和配置 Edge Microgateway。
  • jwt_public_key:(默认:无)指向部署在 Apigee Edge 上的 Edge Microgateway 代理的网址。此代理充当身份验证端点,用于向客户端颁发已签名的访问令牌。当您执行命令以部署代理时,系统会返回此网址:edgemicro configure。如需了解详情,请参阅设置和配置 Edge Microgateway。

edgemicro 属性

这些设置用于配置 Edge Microgateway 进程。

  • port:(默认值:8000)Edge Microgateway 进程监听的端口号。
  • max_connections:(默认:-1)指定 Edge Microgateway 可以接收的同时传入连接数上限。如果超出此数量,系统会返回以下状态:

    res.statusCode = 429; // Too many requests
  • max_connections_hard:(默认:-1)Edge Microgateway 在关闭连接之前可以接收的同时请求数上限。此设置旨在阻止拒绝服务攻击。通常,请将其设置为大于 max_connections 的数字。
  • logging:
    • level:(默认:error)
      • info - 记录流经 Edge Microgateway 实例的所有请求和响应。
      • warn - 仅记录警告消息。
      • error - 仅记录出错提示。
    • dir:(默认:/var/tmp)存储日志文件的目录。
    • stats_log_interval:(默认:60)将统计信息记录写入 API 日志文件的时间间隔(以秒为单位)。
    • rotate_interval:(默认:24)日志文件轮替的时间间隔(以小时为单位)。
  • plugins:插件可为 Edge Microgateway 添加功能。如需详细了解如何开发插件,请参阅开发自定义插件。
  • dir:从 ./gateway 目录到 ./plugins 目录的相对路径,或绝对路径。
  • sequence:要添加到 Edge Microgateway 实例的插件模块列表。这些模块将按照此处指定的顺序执行。
  • debug:向 Edge Microgateway 进程添加远程调试。
    • port:要监听的端口号。例如,将 IDE 调试程序设置为监听此端口。
    • args:调试进程的参数。例如:args --nolazy
  • config_change_poll_interval:(默认:600 秒)Edge Microgateway 会定期加载新配置,并在发生任何更改时执行重新加载。轮询会获取在 Edge 上所做的任何更改(对产品、可感知微网关的代理等的更改)以及对本地配置文件所做的更改。
  • disable_config_poll_interval:(默认:false)设置为 true 可关闭自动更改轮询。

headers 属性

这些设置可配置某些 HTTP 标头的处理方式。

  • x-forwarded-for:(默认:true)设置为 false 可防止将 x-forwarded-for 标头传递到目标。
  • x-forwarded-host:(默认:true)设置为 false 可阻止将 x-forwarded-host 标头传递到目标。
  • x-request-id:(默认:true)设置为 false 可防止将 x-request-id 标头传递到目标。
  • x-response-time:(默认:true)设置为 false 可防止将 x-response-time 标头传递到目标。
  • via:(默认值:true)设置为 false 可防止通过标头传递到目标。

oauth 属性

这些设置用于配置 Edge Microgateway 如何强制执行客户端身份验证。

  • allowNoAuthorization:(默认:false)如果设置为 true,则允许 API 调用在没有任何 Authorization 标头的情况下通过 Edge Microgateway。将此值设置为 false,以要求提供 Authorization 标头(默认)。
  • allowInvalidAuthorization:(默认:false)如果设置为 true,则在 Authorization 标头中传递的令牌无效或过期时,允许 API 调用通过。将此值设置为 false,以要求提供有效令牌(默认)。
  • authorization-header:(默认:Authorization: Bearer)用于将访问令牌发送到 Edge Microgateway 的标头。如果目标需要将 Authorization 标头用于其他目的,您可能需要更改默认值。
  • api-key-header:(默认:x-api-key)用于将 API 密钥传递给 Edge Microgateway 的标头或查询参数的名称。另请参阅使用 API 密钥。
  • keepAuthHeader:(默认:false)如果设置为 true,则请求中发送的 Authorization 标头会传递到目标(即保留)。

插件专用属性

如需详细了解每个插件的可配置属性,请参阅“使用插件”。

过滤代理

您可以过滤 Edge Microgateway 实例将处理哪些可感知微网关的代理。Edge Microgateway 启动时,会下载与其关联的组织中所有支持 Microgateway 的代理。使用以下配置来限制微网关将处理的代理。例如,此配置会将微网关将处理的代理限制为三个:edgemicro_proxy-1、edgemicro_proxy-2 和 edgemicro_proxy-3:

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

遮盖分析数据

以下配置可防止请求路径信息显示在 Edge 分析中。将以下内容添加到 microgateway 配置中,以遮盖请求 URI 和/或请求路径。请注意,URI 由请求的主机名和路径部分组成。

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

调试和问题排查

连接到调试程序

您可以使用调试程序(例如 node-inspector)运行 Edge Microgateway。这对于问题排查和调试自定义插件非常有用。

  1. 在调试模式下重启 Edge Microgateway。为此,请将 DEBUG=* 添加到启动命令的开头。例如:

    DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
  2. 启动调试程序,并将其设置为监听调试进程的端口号。
  3. 现在,您可以单步执行 Edge Microgateway 代码、设置断点、监视表达式等。

您可以指定与调试模式相关的标准 Node.js 标志。例如,--nolazy 有助于调试异步代码。

正在检查日志文件

如果您遇到问题,请务必检查日志文件,了解执行详情和错误信息。如需了解详情,请参阅管理日志文件。

使用 API 密钥安全机制

API 密钥提供了一种简单的机制,用于对向 Edge Microgateway 发出请求的客户端进行身份验证。您可以通过从包含 Edge Microgateway 身份验证代理的 Apigee Edge 产品中复制使用方密钥(也称为客户端 ID)值来获取 API 密钥。

缓存密钥

API 密钥会交换为不记名令牌,这些令牌会被缓存。您可以通过在传入 Edge Microgateway 的请求中设置 Cache-Control: no-cache 标头来停用缓存。

如果您使用的是 Apigee Edge 私有云 15.07 版,则需要采取权宜解决方法

如需在 Edge Private Cloud 15.07 上使用 API 密钥安全机制,您必须实现此处所述的解决方法。该解决方法要求您在 edgemicro-auth 代理中更改 Node.js 文件中的一行,然后重启 Edge Microgateway。

在 Edge 界面中实施权宜解决方法

此过程要求您在完成后重新运行 edgemicro start 命令。

  1. 在 Edge 界面中,在代理编辑器中打开 edgemicro-auth 代理。
  2. 选择“开发”标签页。
  3. 在“导航器”中的“脚本”下,打开名为 verify-api-key.js 的 JavaScript 文件。
  4. 转到第 109 行:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  5. 将“api_product_list:”后面的部分替换为您要使用的任何 API 密钥关联的产品名称的“硬编码”数组。例如,如果您想使用包含“Product-1”和“Product-2”的开发者应用中的密钥,则可以编写如下代码行:

    api_product_list: ["Product-1", "Product-2"]
  6. 点击“保存”。
  7. 执行 edgemicro start 命令。

在本地 Edge Microgateway 代码库中实现

此过程要求您重新运行 edgemicro configure 命令,然后运行 edgemicro start。

  1. 打开文件 <microgateway-root-dir>/edge/auth/api/controllers/verify-api-key.js,其中 <microgateway-root-dir> 是您运行 npm install 命令时安装 Edge Microgateway 的目录。
  2. 转到第 109 行:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  3. 将“api_product_list:”后面的部分替换为您要使用的任何 API 密钥关联的产品名称的“硬编码”数组。例如,如果您想使用包含“Product-1”和“Product-2”的开发者应用中的密钥,则可以编写如下代码行:

    api_product_list: ["Product-1", "Product-2"]
  4. 保存文件。
  5. 执行 edgemicro configure 命令。 (如果您使用的是 Edge 私有云,则为 edgemicro private configure。)此命令会重新部署 edgemicro-auth 代理。
  6. 执行 edgemicro start 命令。

使用 OAuth2 令牌安全性

如需详细了解如何将 OAuth 令牌与代理请求搭配使用,请参阅保护 Edge Microgateway。

使用 API 密钥

如需详细了解如何将 API 密钥与代理请求搭配使用,请参阅保护 Edge Microgateway。

配置 API 密钥名称

默认情况下,x-api-key 是用于 API 密钥标头或查询参数的名称。您可以在配置文件中更改此默认值,如更改配置中所述。 例如,如需将名称更改为 apiKey,请执行以下操作:

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey