Apigee API 中心

Apigee API 中心連接器可讓您管理、探索及控管貴機構組合中的 API。

支援的版本

這個連接器支援 Apigee API 中心 v1 版。

事前準備

  • 在 Google Cloud 專案中，執行下列工作：

    • 確認已設定網路連線。如要瞭解網路模式，請參閱「網路連線」。
    • 將 roles/connectors.admin IAM 角色授予設定連結器的使用者。
    • 啟用下列服務：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如要瞭解如何啟用服務，請參閱「啟用服務」。如果專案先前未啟用這些服務或權限，系統會在您設定連接器時提示啟用。

  • 如果您使用服務帳戶驗證，而非 OAuth 2.0 驗證，請確保服務帳戶已獲得適當權限。詳情請參閱「預先定義的 IAM 角色」。

建立 Apigee API 中心連線

連線專屬於資料來源。也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連結，請按照下列步驟操作：

  1. 在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「Connections」(連線) 頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分中，從「區域」清單選取位置，然後按一下「下一步」。

    如需所有支援區域的清單，請參閱「地點」一文。

  4. 在「連線詳細資料」部分，執行下列操作：
    1. 從「連接器」清單中選取「Apigee API 中心」。
    2. 從「連接器版本」清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。 連線名稱可包含小寫英文字母、數字或連字號。 名稱開頭須為英文字母，結尾須為英文字母或數字，且不得超過 49 個半形字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 視需要啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. (選用) 設定連線節點設定。
      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是處理交易的連線單位 (或副本)。如要處理更多連線交易，就需要更多節點；反之，如要處理較少的交易，則需要較少的節點。如要瞭解節點對連接器定價的影響，請參閱「 連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。
    8. 點選「下一步」。
  5. 在「目的地」部分，輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 在「目的地類型」欄位中選取目的地。
    2. 在「主機地址」欄位中，指定目的地的主機名稱或 IP 位址。

    3. 如要輸入其他目的地，請按一下「+ 新增目的地」。

    4. 點選「下一步」。
  6. 在「Authentication」(驗證) 部分，輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      Apigee API 中心連結支援下列驗證類型：

      • OAuth 2.0 - 授權碼
      • 服務帳戶驗證

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點選「下一步」。
  7. 查看連線和驗證詳細資料，然後按一下「建立」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • OAuth 2.0 - 授權碼：選取這個選項，即可使用以網路為基礎的使用者登入流程進行驗證。指定下列詳細資料：
    • 用戶端 ID： 連線至後端 Apigee API 中心服務時所需的用戶端 ID。
    • 範圍： 以半形逗號分隔的所需範圍清單。如要查看所需 Google 服務支援的所有 OAuth 2.0 範圍，請參閱「Google API 適用的 OAuth 2.0 範圍」頁面中的相關部分。
    • 用戶端密鑰： 選取 Secret Manager 密鑰。 設定這項授權前，您必須先建立 Secret Manager 密鑰。
    • 密鑰版本： 用戶端密鑰的 Secret Manager 密鑰版本。

    如果是 Authorization code 驗證類型，建立連線後必須授權連線。

  • 服務帳戶驗證：選取這個選項，即可使用您在設定這個連線時提供的服務帳戶進行驗證。請確認您已為服務帳戶提供驗證所需的相關 IAM 角色和權限。
    • 範圍： 從下拉式選單中選取所需的 OAuth 2.0 範圍。詳情請參閱「存取範圍」。

授權連結

如果使用 OAuth 2.0 - 授權碼驗證連線，請在建立連線後完成下列工作。

  1. 在「連線」頁面中，找出新建立的連線。

    請注意，新連接器的「狀態」會顯示「需要授權」。

  2. 按一下「需要授權」。

    系統隨即會顯示「編輯授權」窗格。

  3. 將「重新導向 URI」值複製到外部應用程式。
  4. 驗證授權詳細資料。
  5. 按一下「Authorize」。

    授權成功後，「連線」頁面的連線狀態會設為「有效」。

重新授權授權碼

如果您使用 Authorization code 驗證類型，且在 Apigee API 中心進行任何設定變更，就必須重新授權 Apigee API 中心連線。如要重新授權連結，請按照下列步驟操作：

  1. 在「連線」頁面中，按一下所需連線。

    系統隨即會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「驗證」部分中，驗證「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行必要變更。

  4. 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
  5. 在「驗證」部分中，按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
  6. 按一下「Authorize」。

    如果授權成功，「連線」頁面的連線狀態會設為「有效」。

系統限制

Apigee API 中心連接器每秒最多可處理 20 筆交易，每個節點也是如此，且會節流任何超出此限制的交易。根據預設，Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一文。

在整合中，使用 Apigee API 中心連線

建立連線後，即可在 Application Integration 中使用。您可以在整合中透過連接器工作使用連線。

動作

這個連接器會為所連後端服務的物件提供抽象層。您只能透過這個抽象層存取後端的物件。您會以動作的形式看到這項抽象化作業。Action 是透過連接器介面提供給整合作業的一流函式。動作可讓您變更一或多個實體，並因連接器而異。不過，連接器可能不支援任何動作，此時 Actions 清單就會是空白。

已知問題

Apigee API 中心連接器有設定限制。可搜尋的資源大小上限為 2.5 MB，API 規格檔案大小上限為 10 MB。詳情請參閱「Apigee API 中心限制」。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟