本頁面由 Cloud Translation API 翻譯而成。

Edge Microgateway 的作業和設定參考資料

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。資訊

Edge Microgateway 2.5.x 版

本主題說明如何管理及設定 Edge Microgateway。

如有網際網路連線，請將 Edge Microgateway 升級

執行下列 npm 指令，升級至最新版的 Edge Microgateway：
```
npm upgrade edgemicro -g
```
如要升級至特定版本的 Edge Microgateway，您必須指定 versions. number。如果未指定版本號碼，安裝最新版本。舉例來說，如要升級至 2.5.26 版，請使用以下指令：
```
npm upgrade edgemicro@2.5.26 -g
```

查看版本號碼。舉例來說，如果您安裝了 2.5.26 版：

edgemicro --version
current nodejs version is v8.9.0
current edgemicro version is 2.5.26

最後，請升級至最新版的 edgemicro-auth Proxy：

edgemicro upgradeauth -o org_name -e env_name -u username

變更設定

您需要知道的設定檔包括：

預設系統設定檔
新初始化 Edge Microgateway 執行個體的預設設定檔
運作中執行個體的動態設定檔

本節將說明這些檔案，以及變更這些檔案的相關須知。

預設系統設定檔案

安裝 Edge Microgateway 時，預設的系統設定檔位於此處：

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

其中 prefix 是 npm 前置字串目錄。詳情請參閱如果找不到這個目錄，請安裝 Edge Microgateway 在哪裡。

如果您變更系統設定檔，就必須重新初始化、設定並重新啟動 Edge Microgateway：

edgemicro init
edgemicro configure [params]
edgemicro start [params]

新初始化 Edge Microgateway 執行個體的預設設定檔

執行 edgemicro init 時，系統設定檔 (說明如下) 上方)，default.yaml 會放在 ~/.edgemicro 目錄中。

如果您變更 ~/.edgemicro 中的設定檔，則必須重新設定並重新啟動 Edge Microgateway：

edgemicro stop
edgemicro configure [params]
edgemicro start [params]

動態提供給運作中的執行個體

當您執行 edgemicro configure [params] 時，系統會系統會在 ~/.edgemicro中建立設定檔系統將根據格式：org-env-config.yaml，其中 org 和 env 是您的 Apigee Edge 機構和環境名稱。您可以使用這個檔案進行設定並重新載入分頁，過程中完全不需要停機。舉例來說，如果新增並設定外掛程式您可以重新載入設定，不會造成任何停機時間，詳情請見下文。

如果 Edge Microgateway 正在執行 (零停機時間選項)：

重新載入 Edge Microgateway 設定：
```
edgemicro reload -o org_name -e env_name -k key -s secret
```
在此情況下：
- org_name 是您的 Edge 機構名稱 (您必須是機構) 管理員)。
- env_name 是貴機構的環境 (例如「測試」或「prod」)。
- key 是先前由設定指令傳回的鍵。
- secret 是先前由設定指令傳回的鍵。
範例說明
```
edgemicro reload -o docs -e test -k 701e70ee718ce6dc188...78b6181d000723 \
  -s 05c14356e42ed1...4e34ab0cc824
```

如果 Edge Microgateway 停止運作：

重新啟動 Edge Microgateway：
```
edgemicro start -o org_name -e env_name -k key -s secret
```
在此情況下：
- org_name 是您的 Edge 機構名稱 (您必須是機構) 管理員)。
- env_name 是貴機構的環境 (例如「測試」或「prod」)。
- key 是先前由設定指令傳回的鍵。
- secret 是先前由設定指令傳回的鍵。
例如：
```
edgemicro start -o docs -e test -k 701e70ee718ce...b6181d000723 \
  -s 05c1435...e34ab0cc824
```

以下是設定檔範例。如要進一步瞭解設定檔設定，請參閱 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 所需的金鑰和密鑰環境變數：

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，請按照下列步驟操作：

使用 openssl 公用程式或您偏好的方法產生或取得 SSL 憑證和金鑰。

將 edgemicro:ssl 屬性新增至 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
   requestCert: true

敬上

重新啟動 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`	含有私密金鑰、憑證和 CA 憑證的 `pfx` 檔案路徑 PFX 格式的用戶端清單
`passphrase`	包含私密金鑰或 PFX 通關密語的字串。
`ca`	包含 PEM 格式的信任憑證清單檔案路徑。
`ciphers`	字串，說明要使用的加密方式，並用「:」分隔。
`rejectUnauthorized`	如為 true，則會根據提供的 CA 清單驗證伺服器憑證。如果驗證失敗，系統傳回錯誤。
`secureProtocol`	要使用的 SSL 方法。例如，SSLv3_method 將 SSL 強制更新為版本 3。
`servername`	SNI (伺服器名稱指示) TLS 擴充功能的伺服器名稱。
`requestCert`	對雙向 SSL 而言為 true；false 代表單向 SSL

使用用戶端 SSL/TLS 選項

您可以將 Edge Microgateway 設為 TLS 或 SSL 用戶端連線時端點。在 Microgateway 設定檔中，使用目標元素來設定 SSL/TLS 只要設定成「自動重新啟動」和「在主機維護期間」選項即可

以下範例提供的設定會套用至所有主機：

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

在此範例中，設定只會套用至指定的主機：

edgemicro:
...
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 的範例如下：

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

以下列出所有支援的用戶端選項：

選項	說明
`pfx`	含有私密金鑰、憑證和 CA 憑證的 `pfx` 檔案路徑 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 擴充功能的伺服器名稱。

自訂 Edgemicro-auth Proxy

根據預設，Edge Microgateway 會使用 Apigee Edge 上部署的 Proxy 進行 OAuth2 驗證。系統會在您首次執行 edgemicro configure 時部署這個 Proxy。您可以這個 Proxy 的預設設定，為 JSON Web Token 新增自訂憑證附加支援 (JWT)、設定權杖到期時間，以及產生更新權杖。詳情請參閱 GitHub 中的 edgemicro-auth 頁面。

使用自訂驗證服務

根據預設，Edge Microgateway 會使用 Apigee Edge 上部署的 Proxy 進行 OAuth2 驗證。系統會在您首次執行 edgemicro configure 時部署這個 Proxy。根據預設 Proxy 的網址是在 Edge Microgateway 設定檔中指定，如下所示：

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

如果您要使用自己的自訂服務處理驗證，請將設定檔中的 authUri 值，指向服務。舉例來說使用 LDAP 驗證身分的服務。

重要事項：如果您覆寫預設驗證機制新的 Proxy 或服務傳回的回應格式必須與預設 edgemicro-auth Proxy。

管理記錄檔

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 並連結至記錄檔。

如何設定記錄層級

您可以設定以下記錄層級：資訊、warn 和錯誤。建議提供資訊層級。會記錄所有 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

預設情況下，記錄服務會省略下載的 Proxy、產品和 JSON 中的 JSON Web Token (JWT)。如果您希望將這些物件輸出至記錄檔，請設定啟動 Edge Microgateway 時，值為 DEBUG=*。例如：

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

在 Windows 上，使用 SET DEBUG=*

「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 - 視上下文而定。可能是資訊、警告或錯誤則視記錄層級而定可以是統計資料記錄的統計資料、警示警告或發生錯誤。
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 - 視上下文而定。可能是資訊、警告或錯誤則視記錄層級而定可以是統計資料記錄的統計資料、警示警告或發生錯誤。
treq - 用於識別事件。本例中的目標要求就是一個例子。
m - 目標要求中使用的 HTTP 動詞。
u - 網址中基本路徑後的部分。
h：後端目標的主機和通訊埠編號。
i - 記錄項目的 ID。四個活動項目會分享編號。

3. 目標傳入回應的範例

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

1436403888651：Unix 日期戳記

info - 視上下文而定。可能是資訊、警告或錯誤則視記錄層級而定可以是統計資料記錄的統計資料、警示警告或發生錯誤。
tres：用來識別事件。在這種情況下，目標回應。
s - HTTP 回應狀態。
d - 以毫秒為單位的持續時間。API 呼叫花費的時間
i - 記錄項目的 ID。四個活動項目會分享編號。

4. 向用戶端傳出回應的範例

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

1436403888651：Unix 日期戳記

info - 視上下文而定。可能是資訊、警告或錯誤則視記錄層級而定可以是統計資料記錄的統計資料、警示警告或發生錯誤。
res：用於識別事件。在此情況下，回應的用戶端。
s - HTTP 回應狀態。
d - 以毫秒為單位的持續時間。這是指花費的總時間，包括目標 API 花費的時間以及 Edge 花費的時間 Microgateway 本身。
i - 記錄項目的 ID。四個活動項目會分享編號。

記錄檔排程

記錄檔會以 rotate_interval 指定的間隔時間輪替設定屬性。項目會繼續新增至相同的記錄檔，直到輪替間隔到期為止。不過，每次 Edge Microgateway 執行個體重新啟動後會接收新的 UID，並使用這個 UID 建立一組新的記錄檔。其他參考資訊妥善維護的記錄檔做法。

錯誤訊息

部分記錄項目會包含錯誤訊息。為了找出發生錯誤的位置和原因請參閱 Edge Microgateway 錯誤參考資料。

Edge Microgateway 設定參考資料

所在位置設定檔

本節說明的設定屬性位於 Edge Microgateway 中設定檔另請參閱調整設定變更。

Edge_config 屬性

這些設定用於設定 Edge Microgateway 執行個體與 Apigee Edge。

bootstrap：(預設值：無) 指向 Edge 的網址在 Apigee Edge 上執行的微型閘道專屬服務。Edge Microgateway 使用這項服務與 Apigee Edge 通訊當您執行指令來產生公開/私密金鑰組：edgemicro genkeys。如需說明，請參閱設定並設定 Edge Microgateway。
jwt_public_key：(預設值：無) 指向 Edge Microgateway 的網址部署在 Apigee Edge 上的 Proxy這個 Proxy 做為。當您執行指令部署 Proxy：edgemicro configuration如需說明，請參閱設定並設定 Edge Microgateway。

Edgemicro 屬性

這些設定會設定 Edge Microgateway 程序。

port：(預設值：8000) Edge Microgateway 上的通訊埠編號程序接聽。
max_connections：(預設值：-1) 指定 Pod 網路數量上限可同時接收 Edge Microgateway 接收的連線。如果此數字超過的話，系統會傳回下列狀態：

res.statusCode = 429; // Too many requests
max_connections_hard：(預設值：-1) 同時連線數量上限在關閉連線之前，Edge Microgateway 可以接收的要求。這項設定目的在於遏阻阻斷服務攻擊。通常應該設為大於 100 的數字 max_connections.
logging：
- level：(預設：錯誤)
  - 資訊 - 記錄通過 Edge Microgateway 執行個體。
  - warn - 僅記錄警告訊息。
  - error - 僅記錄錯誤訊息。
- dir：(預設值：/var/tmp) 記錄檔所在的目錄儲存。
- stats_log_interval：(預設值：60) 統計資料，以秒為單位則會寫入 API 記錄檔
- rotate_interval：(預設值：24) 間隔，以小時為單位，當記錄檔變成模型也會自動旋轉。

外掛程式：外掛程式可為 Edge Microgateway 新增功能。瞭解詳情若要瞭解如何開發外掛程式，請參閱「開發自訂外掛程式」。

dir：從 ./gateway 目錄到 ./plugins 目錄，或是絕對路徑。
sequence：要新增至 Edge Microgateway 的外掛程式模組清單執行個體。模組將按照此處指定的順序執行。

偵錯： 將遠端偵錯功能新增至 Edge Microgateway 程序。
- port：要監聽的通訊埠編號。例如：設定 IDE 偵錯工具監聽這個連接埠
- args：偵錯程序的引數。例如：args --nolazy
config_change_poll_interval: (預設值：600 秒) Edge Microgateway 定期載入新設定，並在有任何變更時執行重新載入作業。輪詢會擷取在 Edge 上所做的任何變更 (產品變更、微閘道感知 Proxy 等)，以及對本機設定檔所做的變更
disable_config_poll_interval: (預設值：false) 設為 true：關閉自動變更輪詢。
request_timeout：設定目標要求的逾時時間。逾時設定的期限為秒內請求驗證碼。如果逾時，Edge Microgateway 會以 504 狀態碼回應。(已新增 v2.4.x)

標題屬性

這些設定會指定特定 HTTP 標頭的處理方式。

x-forwarded-for：(預設值：true) 設為 false 即可防止 x-forwarded-for 標頭傳遞至目標。請注意，如果標頭為 x-forwarded-for 的值會設為 Edge Analytics 中的 client-ip 值。
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，API 呼叫就會可以在 Authorization 標頭中傳遞的權杖無效或已過期時傳遞。設定此項目設為 false 時，要求有效的權杖 (預設)。
授權標頭：(預設值：Authorization: Bearer) 用於將存取權杖傳送至 Edge Microgateway。建議您變更預設設定，以因應以下情形：有其他用途時，目標必須使用 Authorization 標頭。
api-key-header：(預設值：x-api-key) 標頭或查詢的名稱參數，用來將 API 金鑰傳送至 Edge Microgateway。另請參閱使用 API 金鑰
keep-authorization-header：(預設值：false) 如果設為 true，則授權標頭則會傳遞到目標 (會保留此值)。
allowOAuthOnly -- 若設為 True，則每個 API 都必須具有授權加上不記名存取權杖的標頭。僅允許 OAuth 安全性模型 ( 就能維持回溯相容性)。(新增 2.4.x)
allowAPIKeyOnly -- 如果設為「true」，則每個 API 都必須包含一個 x-api-key 標頭 (或自訂位置)；允許您允許僅限 API 金鑰安全性模型 (同時保有回溯相容性)。(新增 2.4.x)
請勿同時設定 allowOAuthOnly 和 allowAPIKeyOnly 設為 true。預設設定都是 false (適用於回溯相容性)。
gracePeriod：這個參數可防止因輕微錯誤而造成的錯誤系統時鐘與「之前」(nbf) 或「發行時間」(iat) 時間之間的差異並在 JWT 授權憑證中指定的資訊。將此參數設為允許的秒數以便瞭解這些差異(新增 2.5.7)

特定外掛程式屬性

如要進一步瞭解每個外掛程式可設定的屬性，請參閱使用外掛程式。

篩選 Proxy

您可以篩選 Edge Microgateway 執行個體將處理的微型閘道 Proxy。 Edge Microgateway 啟動時，會下載與其他資源建立關聯請使用下列設定限制可進行處理例如，以下設定可限制微閘道使用 Proxy 會處理至三個：edgemicro_proxy-1、edgemicro_proxy-2、和 edgemicro_proxy-3：

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

設定數據分析推送頻率

使用下列設定參數控制 Edge Microgateway 傳送頻率將資料傳送至 Apigee：

bufferSize (選用)：偵測到的數據分析記錄數量上限緩衝區可能在開始捨棄最舊的記錄前，預設：10000
batchSize (選用)：單一批次分析記錄的大小上限就會傳送到 Apigee預設：500
flushInterval (選用)：每次隨機清除之間的毫秒數將一批數據分析記錄傳送到 Apigee預設：5,000

例如：

analytics:
  bufferSize: 15000
  batchSize: 1000
  flushInterval: 6000

遮蓋數據分析資料

以下設定禁止要求路徑資訊顯示在 Edge 中數據分析將下列程式碼新增至微閘道設定，以遮蓋要求 URI，和/或要求路徑請注意，URI 包含要求的主機名稱和路徑部分。

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

在 Edge Analytics 中隔離 API 呼叫

您可以設定數據分析外掛程式來隔離特定的 API 路徑，讓該路徑顯示為使用獨立的 Proxy 處理 Edge Analytics 資訊主頁舉例來說：在資訊主頁中區隔健康狀態檢查 API，避免與實際的 API Proxy 呼叫混淆。在不同 Proxy 的 Analytics 資訊主頁，遵循以下命名模式：

edgemicro_proxyname-health

下圖顯示 Analytics 資訊主頁中兩個不同的 Proxy：edgemicro_hello-health 和 edgemicro_mock-health:

使用這些參數，將 Analytics 資訊主頁中的相對和絕對路徑區隔為個別 Proxy：

relativePath (選用)：指定在數據分析資訊主頁舉例來說，如果您指定 /healthcheck，那麼包含路徑的所有 API 呼叫都會「/healthcheck」在資訊主頁中會顯示為「edgemicro_proxyname-health」。請注意，這個標記會忽略 Proxy 基本路徑。如要根據完整路徑 (包括基本路徑) 隔離，請使用 proxyPath 旗標。
proxyPath (選用)：指定完整的 API Proxy 路徑，包括 Proxy 基本路徑，在數據分析資訊主頁中區隔。舉例來說，如果您指定 /mocktarget/healthcheck 地點：/mocktarget 是 Proxy 基本路徑，含有路徑 /mocktarget/healthcheck 的所有 API 呼叫都會在資訊主頁上顯示為 edgemicro_proxyname-health。

例如，在下列設定中，凡是包含 /healthcheck 的 API 路徑，都會由數據分析外掛程式分隔也就是說，/foo/healthcheck 和 /foo/bar/healthcheck 在數據分析資訊主頁中，系統會將其區隔為 edgemicro_proxyname-health 以外的 Proxy。

analytics:
  uri: >-
    https://xx/edgemicro/ax/org/docs/environment/test
  bufferSize: 100
  batchSize: 50
  flushInterval: 500
  relativePath: /healthcheck

在下列設定中，任何含有 Proxy 路徑 /mocktarget/healthcheck 的 API 都會會獨立為 edgemicro_proxyname-health 這個獨立 Proxy 數據分析資訊主頁

analytics:
  uri: >-
    https://xx/edgemicro/ax/org/docs/environment/test
  bufferSize: 100
  batchSize: 50
  flushInterval: 500
  proxyPath: /mocktarget/healthcheck

在公司防火牆

支援的 2.4.x 版

如果 Edge Microgateway 安裝在防火牆之後，閘道可能無法與 Apigee Edge 通訊在此情況下，您可以考慮採用以下兩種做法：

選項 1：

第一個選項是將 Edgemicro: proxy_tunnel 選項設為 true 微閘道設定檔：

edge_config:

    proxy: http://10.224.16.85:3128
    proxy_tunnel: true

當 proxy_tunnel 為 true 時，Edge Microgateway 會使用 HTTP CONNECT 方法透過單一 TCP 連線通道 HTTP 要求。 (如果用於設定 Proxy 的環境變數為啟用 TLS，也會發生同樣情況)。

選項 2：

第二個選項是在微閘道設定檔例如：

edge_config:
     proxy: http://10.224.16.85:3128
     proxy_tunnel: false

在這種情況下，您可以設定下列變數來控制每個 HTTP 的主機要使用的 Proxy，或是哪些主機不應處理 Edge Microgateway Proxy： HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY。

您可以將 NO_PROXY 設為以半形逗號分隔的網域清單，該清單是由 Edge 指定 Microgateway 不應透過 Proxy 連線。例如：

export NO_PROXY='localhost,localhost:8080'

將 HTTP_PROXY 和 HTTPS_PROXY 設為 HTTP Proxy 端點 Edge Microgateway 可以傳送訊息。例如：

export HTTP_PROXY='http://localhost:3786'

export HTTPS_PROXY='https://localhost:3786'

如要進一步瞭解這些變數，請參閱 https://www.npmjs.com/package/request#controlling-proxy-behaviour-using-environment-variables。

另請參閱

如何在 Apigee 社群中，在公司防火牆後方設定 Edge Microgateway。

在 Microgateway 感知功能中使用萬用字元 Proxy

您可以使用一或多個「*」將萬用字元 edgemicro_* (可辨識微型閘道) Proxy。例如，基礎路徑 /team/*/members 能讓客戶呼叫 https://[host]/team/blue/members 和 https://[host]/team/green/members，不必建立新的 API Proxy 支持新團隊請注意，我們不支援 /**/。

重要事項：Apigee 不支援使用萬用字元「*」作為計算基礎路徑的第一個元素例如「不」支援：/*/ 搜尋。

輪替 JWT 金鑰

初次產生 JWT 後不久，您可能需要將儲存在 Edge 加密 KVM 中的公開/私密金鑰組。新金鑰的產生程序稱為金鑰輪替

Edge Microgateway 如何使用 JWT

JSON Web Token (JWT) 是 RFC7519 中說明的權杖標準。JWT 可讓您簽署一組憑證附加資訊並可由 JWT 接收者驗證。

Edge Microgateway 使用 JWT 做為不記名權杖，確保 OAuth 安全性。產生模型後 Edge Microgateway 的 OAuth 權杖，則會收到 JWT。接著，您便能在 API 呼叫的授權標頭。例如：

curl -i http://localhost:8000/hello -H "Authorization: Bearer eyJhbGciOiJ..dXDefZEA"

產生新的 JWT

您可以使用 edgemicro token 指令或以及 API例如：

edgemicro token get -o docs -e test -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

這個指令會要求 Apigee Edge 產生可用來驗證 API 的 JWT 呼叫。-i 和 -s 參數是開發人員應用程式中的消費者 ID 和密鑰值在您的 Apigee Edge 機構中

您也可以使用 Management API 產生 JWT：

curl -i -X POST "http://org-env.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your consumer key",
    "client_secret": "your consumer secret",
    "grant_type": "client_credentials"
  }'

在此情況下：

org 是您的 Edge 機構名稱 (您必須是機構組織管理員)。
env 是貴機構的環境 (例如「test」或「prod」)。
client_id 是您先前建立的開發人員應用程式中消費者 ID。
client_secret 是您建立的開發人員應用程式中的用戶端密鑰像是剛才說過，即便 VM 正在運作您還是能變更 VM 可用性政策

什麼是金鑰輪替？

初次產生 JWT 後不久，您可能需要將儲存在 Edge 加密 KVM 中的公開/私密金鑰組。新金鑰的產生程序稱為金鑰輪替輪替金鑰時，系統會產生新的私密/公開金鑰組合，儲存在「微型閘道」中Apigee Edge 機構/環境中的 KVM。此外，舊的公開金鑰及其原始金鑰 ID 值一併保留。

為了產生 JWT，Edge 會使用加密 KVM 中儲存的資訊。A 罩杯名為 microgateway 的 KVM 已在您初始設定 (設定) 時建立並填入金鑰 Edge Microgateway。KVM 中的金鑰是用來簽署及加密 JWT。

KVM 金鑰包括：

private_key：用來簽署的最新 (最近建立) RSA 私密金鑰 JWT。
public_key - 用來驗證 JWT 的最新 (最近建立) 憑證使用 private_key 簽署即可
private_key_kid - 最新 (最近建立) 的私密金鑰 ID。這組金鑰 ID 與 private_key 值相關聯，並用於支援金鑰輪替。
public_key1_kid - 最新 (最近建立) 的公開金鑰 ID。這把鑰匙與 public_key1 值相關聯，並用於支援金鑰輪替。這個值與私密金鑰的子項相同
public_key1 - 最新的 (最近建立) 公開金鑰。

執行金鑰輪替時，對應中現有的鍵/值會取代並新的。例如：

public_key2_kid - 舊的公開金鑰 ID。這組金鑰與 public_key2 值，用於支援金鑰輪替。
public_key2 - 舊版公開金鑰。

系統會利用新的公開金鑰，驗證您提供給驗證的 JWT。如果驗證失敗，系統就會使用舊的公開金鑰，直到金鑰過期 (30 分鐘後) 為止。於即可透過這種方式「旋轉」而不會立即中斷 API 流量。

如何輪替金鑰

本節說明如何執行金鑰輪替。

如果您將 Edge Microgateway 執行個體設為 2.5.2 以下版本

如果您在版本 2.5.2 之前設定 Edge Microgateway 執行個體，則必須執行以下兩個指令即可升級 KVM 和驗證政策：

upgradekvm -o org -e env -u username

如要進一步瞭解這個指令，請參閱升級 KVM

下一個指令會升級已部署至 edgemicro-oauth Proxy 您的 Apigee 機構 (亦即設定 Edge Microgateway) 時。這個 Proxy 可以為產生符記

upgradeauth -o org -e env -u username

如要進一步瞭解此指令，請參閱升級 Edgemicro-auth Proxy。

輪替金鑰

在 ~/.edgemicro/org-env-config.yaml 檔案中新增下列程式碼，您必須指定您在微閘道設定要使用的機構和環境：

jwk_public_keys: 'https://org-env.apigee.net/edgemicro-auth/jwkPublicKeys'

執行金鑰輪替指令來輪替金鑰。(如要進一步瞭解此指令，請參閱輪替金鑰)。

edgemicro rotatekey -o org -e env -u username -k kid_value

例如：

edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2
current nodejs version is v6.9.1
current edgemicro version is 2.5.7
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

-k 參數會指定金鑰 ID (kid)。這個 ID 是用來比對特定鍵。 Edge Microgateway 會在金鑰輪替時，使用這個值選擇一組金鑰。如要請參閱第 4.5 節 JSON Web 金鑰規格。

金鑰輪替後，Edge 會將多個金鑰傳回 Edge Microgateway。「下列範例中，每個鍵都有專屬的「kid」(金鑰 ID) 值。微型門接著會使用這些通道驗證授權權杖。如果權杖驗證失敗，微閘道會尋找看看該鍵中是否有較舊的金鑰，並嘗試輸入該鍵。傳回的金鑰為 JSON Web Key (JWK)。如要瞭解這種格式，請參閱 RFC 7517。

{
  "keys": [
    {
      "kty": "RSA",
      "n": "nSl7R_0wKLiWi6cO3n8aOJwYGBtinq723Jgg8i7KKWTSTYoszOjgGsJf_MX4JEW1YCScwpE5o4o8ccQN09iHVTlIhk8CNiMZNPipClmRVjaL_8IWvMQp1iN66qy4ldWXzXnHfivUZZogCkBNqCz7VSC5rw2Jf57pdViULVvVDGwTgf46sYveW_6h8CAGaD0KLd3vZffxIkoJubh0yMy0mQP3aDOeIGf_akeZeZ6GzF7ltbKGd954iNTiKmdm8IKhz6Y3gLpC9iwQ-kex_j0CnO_daHl1coYxUSCIdv4ziWIeM3dmjQ5_2dEvUDIGG6_Az9hTpNgPE5J1tvrOHAmunQ",
      "e": "AQAB",
      "kid": "2"
    },
    {
      "kty": "RSA",
      "n": "8BKwzx34BMUcHwTuQtmp8LFRCMxbkKg_zsWD6eOMIUTAsORexTGJsTy7z-4aH0wJ3fT-3luAAUPLBQwGcuHo0P1JnbtPrpuYjaJKSZOeIMOnlryJCspmv-1xG4qAqQ9XaZ9C97oecuj7MMoNwuaZno5MvsY-oi5B_gqED3vIHUjaWCErd4reONyFSWn047dvpE6mwRhZbcOTkAHT8ZyKkHISzopkFg8CD-Mij12unxA3ldcTV7yaviXgxd3eFSD1_Z4L7ZRsDUukCJkJ-8qY2-GWjewzoxl-mAW9D1tLK6qAdc89yFem3JHRW6L1le3YK37-bs6b2a_AqJKsKm5bWw",
      "e": "AQAB",
      "kid": "1"
    }
  ]
}

篩選已下載的 Proxy

根據預設，Edge Microgateway 會下載 Edge 機構中的所有 Proxy 名稱前置字串為「edgemicro_」你可以變更這項預設設定，以便下載 Proxy 名稱符合某個模式。

開啟 Edge Micro 設定檔：~/.edgemicro/org-env-config.yaml
在 Edge_config 下方新增 ProxyPattern 元素。舉例來說，下列模式下載 Edgemicro_foo、edgemicro_fast 和 Edgemicro_first 等 Proxy。
```
edge_config:
…
proxyPattern: edgemicro_f*
```

指定沒有 API Proxy 的產品

在 Apigee Edge 中，您可以建立不含任何 API Proxy 的 API 產品。這項產品設定可讓與該產品相關聯的 API 金鑰適用於任何已部署在貴機構中自 2.5.4 版起，Edge Microgateway 支援這項產品此外還會從 0 自動調整資源配置您完全不必調整資源調度設定

偵錯與疑難排解

連線至偵錯工具

您可以搭配偵錯工具執行 Edge Microgateway，例如 node-inspector。這對於使用者排解自訂外掛程式的問題及偵錯

以偵錯模式重新啟動 Edge Microgateway。做法是將 DEBUG=* 加入 start指令的開頭。例如：

DEBUG=* edgemicro start -o  myorg -e test -k
      db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s
      6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed

敬上

在 Windows 上，請使用 SET DEBUG=*

啟動偵錯工具，並將其設定為監聽通訊埠號碼，以便偵錯程序。
您現在可以逐步執行 Edge Microgateway 程式碼、設定中斷點、觀察運算式依此類推

您可以指定與偵錯模式相關的標準 Node.js 標記。例如： --nolazy 有助於對非同步程式碼進行偵錯。

檢查記錄檔

如果發生問題，請務必檢查記錄檔，取得執行詳情和錯誤可能不準確或不適當詳情請參閱管理記錄檔。

使用 API 金鑰安全性

API 金鑰提供簡單機制，可讓用戶端向 Edge 提出要求 Microgateway。只要複製用戶端金鑰 (也稱為 Client ID) 值，即可取得 API 金鑰。

快取金鑰

API 金鑰會交換供快取的不記名權杖。您可以透過對 Edge 發出的傳入要求上的 Cache-Control: no-cache 標頭 Microgateway。

使用 API 金鑰

您可以將 API 金鑰以查詢參數或標頭的形式傳遞到 API 要求中。根據預設標頭和查詢參數的名稱都是 x-api-key。

查詢參數範例：

curl http://localhost:8000/foobar?x-api-key=JG616Gjz7xs4t0dvpvVsGdI49G34xGsz

標頭範例：

curl http://localhost:8000/foobar -H "x-api-key:JG616Gjz7xs4t0dvpvVsGdI49G34xGsz"

設定 API 金鑰名稱

根據預設，x-api-key 會同時用於 API 金鑰標頭和查詢參數。您可以依照變更設定的說明，在設定檔中變更這項預設設定。舉例來說，如要將 apiKey：

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

在這個範例中，查詢參數和標頭名稱都已變更為 apiKey。這兩種名稱「x-api-key」將無法再運作。其他參考資訊變更設定。

例如：

curl http://localhost:8000/foobar -H "apiKey:JG616Gjz7xs4t0dvpvVsGdI49G34xGsz"

如需進一步瞭解如何搭配使用 API 金鑰與 Proxy 要求，請參閱 Secure Edge Microgateway。

使用 OAuth2 權杖安全性

本節說明如何取得 OAuth2 存取權杖和更新權杖。存取權杖確保 API 呼叫安全無虞系統會使用更新權杖來取得新的存取權杖。

如何取得存取權杖

本節說明如何使用 edgemicro-auth Proxy 取得存取權杖。

您也可以使用 edgemicro token CLI 指令取得存取權杖。如要進一步瞭解 CLI，請參閱「管理權杖」。

API 1

請在網址中替換您的機構和環境名稱。以及替換從 Apigee 上開發人員應用程式取得的消費端 ID 和用戶端密鑰值 client_id 和 client_secret 主體參數的邊緣：

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" \
-d '{"grant_type": "client_credentials", "client_id": "your_client_id", \
"client_secret": "your_client_secret"}' -H "Content-Type: application/json"

API 2

(已在 2.5.31 版中新增) 以「基本驗證」標頭的形式傳送用戶端憑證，而且 grant_type 做為表單參數。我們也在 RFC 6749：OAuth 2.0 授權架構。

http://<org>-<test>.apigee.net/edgemicro-auth/token -v -u your_client_id:your_client_secret \
-d 'grant_type=client_credentials' -H "Content-Type: application/x-www-form-urlencoded"

輸出內容範例

API 會傳回 JSON 回應。請注意，token 與 access_token 屬性。您可以擇一使用。

{
"token": "eyJraWQiOiIxIiwidHlwIjoi",
"access_token": "eyJraWQiOiIxIiwid",
"token_type": "bearer",
"expires_in": "108000"
}

如何取得更新權杖

如要取得更新權杖，請向/token edgemicro-auth Proxy。您必須透過 password 發出這個 API 呼叫授權類型。下列步驟會逐步完成設定程序。

透過 /token API 取得存取權和更新權杖。請注意，授權類型為 password：

curl -X POST \
  https://your_organization-your_environment.apigee.net/edgemicro-auth/token \
  -H 'Content-Type: application/json' \
  -d '{
   "client_id":"mpK6l1Bx9oE5zLdifoDbF931TDnDtLq",
   "client_secret":"bUdDcFgv3nXffnU",
   "grant_type":"password",
   "username":"mpK6lBx9RoE5LiffoDbpF931TDnDtLq",
   "password":"bUdD2FvnMsXffnU"
}'

API 會傳回存取權杖和更新權杖。回應看起來與：

{
    "token": "your-access-token",
    "access_token": "your-access-token",
    "token_type": "bearer",
    "expires_in": "108000",
    "refresh_token": "your-refresh-token",
    "refresh_token_expires_in": "431999",
    "refresh_token_issued_at": "1562087304302",
    "refresh_token_status": "approved"
}

您現在可以呼叫相同 API 的 /refresh 端點。例如：

curl -X POST \
  https://willwitman-test.apigee.net/edgemicro-auth/refresh \
  -H 'Content-Type: application/json' \
  -d '{
   "client_id":"mpK6l1Bx9RoE5zLifoDbpF931TDnDtLq",
   "client_secret":"bUdDc2Fv3nMXffnU",
   "grant_type":"refresh_token",
   "refresh_token":"your-refresh-token"
}'

API 會傳回新的存取權杖。回應看起來會像這樣：

{
    "token": "your-new-access-token"
    }

永久監控

Forever 是一個 Node.js 工具如果程序當機或發生錯誤，會自動重新啟動 Node.js 應用程式。邊緣您可以設定 Microgateway 提供的 forever.json 檔案，藉此控制以及 Edge Microgateway 應重新啟動的間隔時間。這個檔案會設定一律稱為「永久監控」的服務，會永久管理編寫程式

您可以在 Edge Microgateway 根目錄安裝中找到 forever.json 檔案目錄。詳情請參閱 Edge Microgateway 安裝在哪裡。如要進一步瞭解設定選項，請參閱。

edgemicro forever 指令包含旗標，可讓您指定 forever.json 檔案 (-f 旗標)，並啟動/停止永久監控程序 (-a 旗標)。例如：

edgemicro forever -f ~/mydir/forever.json -a start

詳情請參閱 CLI 參考資料中的永久監控。

指定設定檔端點

如果您同時執行多個 Edge Microgateway 執行個體，您可能會想管理各個執行個體的設定從單一位置收集資訊方法是指定 Edge Micro 可以存取的 HTTP 端點下載設定檔您可以在啟動 Edge Micro 時透過以下方式指定這個端點： -u 標記。

例如：

edgemicro start -o jdoe -e test -u http://mylocalserver/mgconfig -k public_key -s secret_key

mgconfig 端點會傳回設定檔的內容。這就是檔案該屬性預設為 ~/.edgemicro，並採用命名慣例： org-env-config.yaml。

停用 TCP 連線資料緩衝功能

您可以使用 nodelay 設定屬性停用以下項目的資料緩衝功能： Edge Microgateway 使用的 TCP 連線。

根據預設，TCP 連線會使用 Nagle 演算法來緩衝資料，然後再傳送資料。將nodelay設為「true」，停用此行為 (資料將在每次時立即觸發資料) 系統會呼叫 socket.write())。另請參閱 Node.js 說明文件。

如要啟用 nodelay，請按照下列方式編輯 Edge Micro 設定檔：

edgemicro:
  nodelay: true
  port: 8000
  max_connections: 1000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

在獨立模式下執行 Edge Microgateway

您可以執行完全中斷與任何連線的 Edge Microgateway Apigee Edge 依附元件。這個情境稱為獨立模式，可讓您執行及測試 Edge Microgateway 沒有網路連線

在獨立模式下，下列功能需要連線才能運作遷移至 Apigee Edge：

OAuth 和 API 金鑰
配額
數據分析

另一方面，自訂外掛程式和尖峰流量則不如預期工作，因為必須連線至 Apigee Edge此外，名為 extauth 的新外掛程式還可讓您在獨立模式下，透過 JWT 授權 API 呼叫微閘道。

設定及啟動閘道

如何在獨立模式下執行 Edge Microgateway：

確認您已安裝 Edge Microgateway 2.5.25 以上版本。如果不是，您就必須執行下列指令來升級至最新版本：
```
npm install -g edgemicro
```
如需協助，請參閱「安裝 Edge」一文 Microgateway。
建立設定檔，如下所示：$HOME/.edgemicro/org_name-env_name-config.yaml
您可以在檔案名稱中使用任何想要用於 org_name 和 env_name 的值。使用 org/env 組合就只是一種慣例，可讓 Edge Microgateway 在啟動過程

例如：
```
vi $HOME/.edgemicro/foo-bar-config.yaml
```
將下列程式碼貼入檔案：
```
edgemicro:
  port: 8000
  max_connections: 1000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - extauth
      - spikearrest
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
extauth:
  publickey_url: https://www.googleapis.com/oauth2/v1/certs
spikearrest:
  timeUnit: second
  allow: 10
  buffersize: 0
```
敬上
設定檔包含一個名為 extauth 的特殊選用外掛程式。這個外掛程式驗證傳遞至微閘道的有效 JWT 權杖。在後續步驟中，您將學習如何才能取得並使用權杖另外，請注意 spikearrest 外掛程式，因為不需要與 Edge 連線。quota 排除 oauth 和 analytics 外掛程式，因為它們必須與 Edge 和將無法在離線模式下運作。允許使用自訂外掛程式，且能正常運作正常運作。
匯出下列環境變數，並將值設為「1」：
```
export EDGEMICRO_LOCAL=1
```
執行下列 start 指令，並在其中提供值，將本機 Proxy：
```
edgemicro start -o org_name -e environment_name -a local_proxy_name \
  -v local_proxy_version -t target_url -b base_path
```
在此情況下：
- your_org 是「org」您使用的設定檔名稱。
- your_environment 是「env」您在設定檔所使用的名稱。
- local_proxy_name 是要建立的本機 Proxy 名稱。別擔心！您可以使用任意名稱
- local_proxy_version 是 Proxy 的版本編號。
- target_url 是 Proxy 目標的網址。(目標是服務)。
- base_path 是 Proxy 的基本路徑。這個值的開頭必須是正數斜線如果是根基本路徑，只要指定正斜線即可例如「/」
例如：
```
edgemicro start -o local -e test -a proxy1 -v 1 -t http://mocktarget.apigee.net -b /
```
測試設定。
```
curl http://localhost:8000/echo  { "error" : "missing_authorization" }
```
extauth 外掛程式位於 foo-bar-config.yaml 檔案中，因此您取得「missing_authorization」錯誤。這個外掛程式會驗證必須存在於授權中的 JWT API 呼叫的標頭。在下一節中，您將取得允許 API 呼叫的 JWT 略過錯誤

範例：取得授權權杖

以下範例說明如何在 Apigee Edge (edgemicro-auth/jwkPublicKeys) 上從 Edge Microgateway JWT 端點取得 JWT。執行 Edge Microgateway 的標準設定和設定時，系統會部署這個端點。如要從 Apigee 端點取得 JWT，您必須先執行標準 Edge Microgateway 設定，並且連線至網際網路這裡會使用 Apigee 端點並非強制規定您可以視需要使用其他 JWT 權杖端點。若輸入 JWT，則必須使用為該端點提供的 API

在微閘道設定中加入 extauth 外掛程式並非必要，但如果您有包含這些資訊，在 API 呼叫的授權標頭中提供有效的 JWT 權杖。

下列步驟說明如何使用 edgemicro-auth/jwkPublicKeys 端點取得權杖：

您必須執行一個標準 Edge Microgateway 的設定與設定，以便部署 edgemicro-auth Proxy 部署至您的機構/環境如果先前已執行此步驟，就不需要重複這個步驟。
如果您已將 Edge Microgateway 部署到 Apigee Cloud，就必須連上網際網路，才能從這個端點取得 JWT。
停止 Edge Microgateway：
```
edgemicro stop
```
在先前建立的設定檔中 ($HOME/.edgemicro/org-env-config.yaml)，指向 extauth:publickey_url 屬性設為 Apigee Edge 機構/環境中的 edgemicro-auth/jwkPublicKeys 端點。例如：
```
extauth:
  publickey_url: 'https://your_org-your_env.apigee.net/edgemicro-auth/jwkPublicKeys'
```
以先前在設定檔名稱中使用的 org/env 名稱重新啟動 Edge Microgateway。例如：
```
edgemicro start -o foo -e bar -a proxy1 -v 1 -t http://mocktarget.apigee.net -b /
```
從授權端點取得 JWT 權杖。因為您使用的是「edgemicro-auth/jwkPublicKeys」可以採用以下 CLI 指令：
您需要連線網際網路，才能進行此步驟。下列指令會擷取取得 kubectl 權杖如要執行這個步驟，您必須具備 Apigee 機構您執行了標準的 Edge Microgateway 安裝與設定。完成這個步驟後，您就不需要連線至 Wi-Fi 網路網際網路權杖在過期前，都會以獨立模式運作。

您可以使用 edgemicro token 指令或以及 API例如：

edgemicro token get -o your_org -e your_env \
  -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

在此情況下：

your_org 是您先前的 Apigee 機構名稱已設定 Edge Microgateway
your_env 是機構中的環境，
i 選項會指定開發人員應用程式為有產品提供的消費者金鑰，包括 edgemicro-auth Proxy
s 選項會指定開發人員應用程式提供的用戶端密鑰，包括 edgemicro-auth Proxy 的產品

這個指令會要求 Apigee Edge 產生可用來驗證 API 的 JWT 呼叫。

另請參閱產生權杖。

測試獨立設定

如要測試設定，請使用在 Authorization 標頭中新增的憑證呼叫 API，如下所示：

curl http://localhost:8000/echo -H "Authorization: Bearer your_token

範例：

curl http://localhost:8000/echo -H "Authorization: Bearer eyJraWQiOiIxIiwidHlwIjo...iryF3kwcDWNv7OQ"

輸出內容範例：

{
   "headers":{
      "user-agent":"curl/7.54.0",
      "accept":"*/*",
      "x-api-key":"DvUdLlFwG9AvGGpEgfnNGwtvaXIlUUvP",
      "client_received_start_timestamp":"1535134472699",
      "x-authorization-claims":"eyJhdDbiO...M1OTE5MTA1NDkifQ==",
      "target_sent_start_timestamp":"1535134472702",
      "x-request-id":"678e3080-a7ae-11e8-a70f-87ae30db3896.8cc81cb0-a7c9-11e8-a70f-87ae30db3896",
      "x-forwarded-proto":"http",
      "x-forwarded-host":"localhost:8000",
      "host":"mocktarget.apigee.net",
      "x-cloud-trace-context":"e2ac4fa0112c2d76237e5473714f1c85/1746478453618419513",
      "via":"1.1 localhost, 1.1 google",
      "x-forwarded-for":"::1, 216.98.205.223, 35.227.194.212",
      "connection":"Keep-Alive"
   },
   "method":"GET",
   "url":"/",
   "body":""
}

使用本機 Proxy 模式

在本機 Proxy 模式中，Edge Microgateway 不需要微閘道感知 Proxy 以便部署在 Apigee Edge 上而是應設定「本機 Proxy」方法是提供本機 Proxy 名稱、basepath 及目標網址啟動微門接著，向微閘道發出的 API 呼叫會傳送至目標本機 Proxy 的網址。在所有其他情況下，本機 Proxy 模式的運作方式都與執行中 Edge Microgateway 正常模式中。驗證作業的運作方式與遽增率相同逮捕和配額限制、自訂外掛程式等

本機模式和一般 Edge Microgateway 兩者之間的兩個重要差異 (1) 在本機模式中，您不需要建立微閘道感知和 (2) 在 Edge 中建立 API 產品時，您只能為該 Proxy 新增一個 Proxy。 edgemicro-auth Proxy您無須在產品中新增任何其他 Proxy。

用途和範例

如果只需要將單一 Proxy 連結至 Edge Microgateway，本機 Proxy 模式就相當實用執行個體。舉例來說，您可以將 Edge Microgateway 插入 Kubernetes 做為補充資訊 Proxy，其中微型閘道與服務均在單一 Pod 中運作以及透過隨附服務安裝的容器下圖說明 Edge 的這個架構 Microgateway 功能在 Kubernetes 叢集中可做為補充 Proxy。每個微閘道執行個體附加至隨附服務上的單一端點：

Edgemicro 做為補充資訊

這種架構的優點之一是 Edge Microgateway 提供 API 可管理部署至容器環境的個別服務，例如儲存空間

設定本機 Proxy 模式

如要將 Edge Microgateway 設為在本機 Proxy 模式中執行，請按照下列步驟操作：

確認您已安裝 Edge Microgateway 2.5.25 以上版本。如果不是，您就必須執行下列指令來升級至最新版本：
```
npm install -g edgemicro
```
如需協助，請參閱「安裝 Edge」一文 Microgateway。
執行 edgemicro init 以正確設定本機設定環境做法與一般 Edge Microgateway 設定中相同其他參考資訊設定 Edge Microgateway。
執行 edgemicro configure，就像在一般 Edge Microgateway 設定中一樣程序。例如：
```
edgemicro configure -o your_org -e your_env -u your_apigee_username
```
這個指令會將 edgemicro-auth 政策部署至 Edge 並傳回金鑰和密鑰啟動微門如需協助，請參閱：設定 Edge Microgateway。
在 Apigee Edge 中建立 API 產品並採用下列必要設定需求 (您可以視需要管理其他所有設定)：
- 您「必須」在產品中新增 edgemicro-auth Proxy。這個 Proxy 是在執行 edgemicro configure 時自動部署。
- 您「必須」提供資源路徑。Apigee 建議將此路徑新增至產品：/**。詳情請參閱「設定資源路徑的行為」。另請參閱建立 API 產品一文。
請在 Apigee Edge 中建立開發人員。如果您需要，則可以使用現有的開發人員願望。如需相關說明，請參閱使用 Edge 管理 UI 新增開發人員。
在 Apigee Edge 中建立開發人員應用程式。您必須新增自己設定的 API 產品提供給應用程式的所有事件如需相關說明，請參閱「在 Edge 中註冊應用程式管理 UI
在安裝 Edge Microgateway 的機器上，匯出以下內容值為「1」的環境變數
```
export EDGEMICRO_LOCAL_PROXY=1
```
執行下列 start 指令：
```
edgemicro start -o your_org -e your_environment -k your_key -s your_secret \
    -a local_proxy_name -v local_proxy_version -t target_url -b base_path
```
在此情況下：
- your_org 是您的 Apigee 機構。
- your_environment 是貴機構的環境。
- your_key 是您執行時傳回的鍵 edgemicro configure。
- your_secret 是執行時傳回的密鑰 edgemicro configure。
- local_proxy_name 是要建立的本機 Proxy 名稱。
- local_proxy_version 是 Proxy 的版本編號。
- target_url 是 Proxy 目標的網址 (Proxy 會呼叫)。
- base_path 是 Proxy 的基本路徑。這個值的開頭必須是正數斜線如果是根基本路徑，只要指定正斜線即可例如「/」
例如：
```
edgemicro start -o your_org -e test -k 7eb6aae644cbc09035a...d2eae46a6c095f \
  -s e16e7b1f5d5e24df...ec29d409a2df853163a -a proxy1 -v 1 \
  -t http://mocktarget.apigee.net -b /echo
```

測試設定

您可以呼叫 Proxy 端點，測試本機 Proxy 設定。例如：如果您已指定 /echo 的基本路徑，則可呼叫 Proxy，如下所示：

curl  http://localhost:8000/echo
{
  "error" : "missing_authorization",
  "error_description" : "Missing Authorization header"
}

由於您並未提供有效的 API 金鑰，這項初始 API 呼叫會產生錯誤。就在。在 Edge UI 中開啟應用程式，然後複製用戶端金鑰，並使用該金鑰如下：

curl  http://localhost:8000/echo -H 'x-api-key:your_api_key'

例如：

curl  http://localhost:8000/echo -H "x-api-key:DvUdLlFwG9AvGGpEgfnNGwtvaXIlUUvP"

輸出內容範例：

{
  "headers":{
    "user-agent":"curl/7.54.0",
    "accept":"*/*",
    "x-api-key":"DvUdLlFwG9AvGGpEgfnNGwtvaXIlUUvP",
    "client_received_start_timestamp":"1535134472699",
    "x-authorization-claims":"eyJhdWQiOi...TQ0YmUtOWNlOS05YzM1OTE5MTA1NDkifQ==",
    "target_sent_start_timestamp":"1535134472702",
    "x-request-id":"678e3080-a7ae-11e8-a70f-87ae30db3896.8cc81cb0-a7c9-11e8-a70f-87ae30db3896",
    "x-forwarded-proto":"http",
    "x-forwarded-host":"localhost:8000",
    "host":"mocktarget.apigee.net",
    "x-cloud-trace-context":"e2ac4fa0112c2d76237e5473714f1c85/1746478453618419513",
    "via":"1.1 localhost, 1.1 google",
    "x-forwarded-for":"::1, 216.98.205.223, 35.227.194.212",
    "connection":"Keep-Alive"
  },
  "method":"GET",
  "url":"/",
  "body":""
}

Edge Microgateway 的作業和設定參考資料

如有網際網路連線，請將 Edge Microgateway 升級

變更設定

預設系統設定 檔案

新初始化 Edge Microgateway 執行個體的預設設定檔

動態 提供給運作中的執行個體

設定環境變數

在 Edge Microgateway 上設定 SSL 伺服器

使用用戶端 SSL/TLS 選項

自訂 Edgemicro-auth Proxy

使用自訂驗證服務

管理記錄檔

記錄檔儲存位置

如何變更預設紀錄 檔案目錄

將記錄檔傳送至控制台

如何設定記錄層級

如何變更記錄檔間隔

良好的記錄檔維護做法

記錄檔命名慣例

關於記錄檔內容

「API」的內容記錄檔

1. 用戶端傳入要求的範例：

2. 向目標發出的外送要求範例：

記錄檔排程

錯誤訊息

Edge Microgateway 設定參考資料

所在位置 設定檔

Edge_config 屬性

Edgemicro 屬性

標題屬性

OAuth 屬性

特定外掛程式 屬性

篩選 Proxy

設定數據分析推送頻率

遮蓋數據分析資料

在 Edge Analytics 中隔離 API 呼叫

在 公司防火牆

另請參閱

在 Microgateway 感知功能中使用萬用字元 Proxy

輪替 JWT 金鑰

Edge Microgateway 如何使用 JWT

產生新的 JWT

什麼是金鑰輪替？

如何輪替金鑰

如果您將 Edge Microgateway 執行個體設為 2.5.2 以下版本

輪替金鑰

篩選已下載的 Proxy

指定沒有 API Proxy 的產品

偵錯與疑難排解

連線至偵錯工具

檢查記錄檔

使用 API 金鑰安全性

快取金鑰

使用 API 金鑰

設定 API 金鑰名稱

使用 OAuth2 權杖安全性

如何取得存取權杖

如何取得更新權杖

永久監控

指定設定檔端點

停用 TCP 連線資料緩衝功能

在獨立模式下執行 Edge Microgateway

設定及啟動閘道

範例：取得授權權杖

測試獨立設定

使用本機 Proxy 模式

用途和範例

設定本機 Proxy 模式

測試設定

預設系統設定檔案

動態提供給運作中的執行個體

如何變更預設紀錄檔案目錄

所在位置設定檔

特定外掛程式屬性

在公司防火牆