步驟 3:使用額外資訊摘要政策

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

開發 API Proxy 時,您可以為 Proxy 新增擴充功能呼叫政策,藉此為擴充功能提供支援。(如需建立簡易 Proxy 的協助,請參閱建構第一個 Proxy 一文)。

新增擴充功能支援時,您需要將 ExtensionSummary 政策連結至已設定的擴充功能。這項擴充功能設定可定義擴充功能與其連線後端資源的互動方式。這是經過特別設定的擴充功能,可擴充功能呼叫政策會整合至 API Proxy。

如何將擴充功能新增至 API Proxy:

  1. 在 Apigee Edge 控制台的「開發」檢視畫面中開啟 API Proxy。

    儘管只有機構組織管理員才能建立擴充功能,但任何使用者角色都能將擴充功能新增至 API Proxy。

  2. 在「Navigator」窗格中,選取「PreFlow」

  3. 按一下右上角的「+ 步驟」按鈕即可新增政策。

  4. 在「新增步驟」對話方塊左側的政策清單中,按一下「擴充功能摘要」

    如果清單中沒有列出「ExtensionSummary」政策,請務必使用新的 Edge UI。此外,Apigee 擴充功能目前僅供 Apigee Edge Cloud Enterprise 客戶使用。

  5. 在右側窗格中,選取設定政策的選項:
    欄位 說明
    顯示名稱 輸入政策的顯示名稱。
    名稱 透過程式輔助方式輸入要用於政策的名稱。在 Proxy 中不得重複。
    擴充功能 選擇要使用的擴充功能。這是你先前設定的擴充功能。
    動作 選取「記錄」動作。
  6. 按一下 [新增]。
  7. 在流程檢視畫面中,按一下政策即可查看設定 XML。

    新增擴充功能時,即可取得政策 XML 範例。請注意,其中包含了說明如何建構 <Input> 元素設定結構的結構定義。(您可以忽略 <Output> 元素結構定義,擴充功能「log」動作未傳回任何回應主體)。

  8. 編輯政策 XML,使其如下所示:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Extension-Callout-Beta-1">
      <DisplayName>Logging Extension</DisplayName>
      <Connector>my-logging-extension</Connector>
      <Action>log</Action>
      <Input>{
        "logName": "example-log",
        "metadata": {
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "my-gcp-project"
            }
          }
        },
        "message": "This is a test"
      }</Input>
    </ConnectorCallout><!--
    Input JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"logName":{"type":"string"},"metadata":{"type":"string"},"message":{"type":"string"}},"required":["logName","message"]}
    -->
    <!--
    Output JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"content":{"type":"string"}},"required":[]}
    -->

    這裡的 <Input> 定義下列項目:

    • logName 是要寫入的記錄名稱。如果不存在,擴充功能將會建立這個設定檔。
    • metadata 會指定可用於在 Stackdriver 控制台中瀏覽記錄檔的資訊。
    • message 是您要寫入的記錄訊息。
  9. 按一下 [儲存] 按鈕。

後續步驟

步驟 1 步驟 2 步驟 3 步驟 4:部署 Proxy 步驟 5