瞭解機構

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

機構是 Apigee 中的頂層容器，Apigee 機構包含所有 API Proxy 和相關資源。本主題的其餘部分會深入探討機構，以下是一些實用要點：

  • Apigee 機構與 Google Cloud 機構不同，且隸屬於後者。為 Apigee X 或 Apigee Hybrid 建立機構時，該機構會對應至一個 Google Cloud 專案，且 Apigee 機構和 Google Cloud 專案會共用名稱。並非所有 Google Cloud 專案都有相關聯的 Apigee 機構。
  • Apigee 說明文件中的「機構」一詞，專指 Apigee 機構。Apigee 說明文件使用「Google Cloud 機構」一詞來指稱替代方案。
  • Apigee 機構一經建立即無法重新命名。
  • 在 the Google Cloud console 的 Apigee 專區網址中，您的 Apigee 機構名稱會顯示為專案。例如： 
    https://console.cloud.google.com/apigee/overview?project=ORG_ID
  • 對 Apigee API 叫用 REST 呼叫時，路徑中必須包含機構組織 ID。舉例來說，下列 curl 要求會使用 organizations API，傳回機構中的所有 API Proxy 清單：
    curl https://apigee.googleapis.com/v1/organizations/ORG_ID/apis
  • 您可能只建立了一個機構，但也可以在其他機構中獲得授權，成為具有特定權限的使用者或管理員。在 Cloud Console 中，您可以切換至其他機構，詳情請參閱「在機構之間切換」。

影片：觀看短片，瞭解機構如何支援 API 管理的多租戶架構。

機構類型

機構分為兩種：

  • 付費：永久機構，具備完整擴充性。又稱為製作機構。付費機構包括透過訂閱或即付即用 Apigee 定價模式建立的機構。

  • 評估：用於測試 Apigee 的臨時自助式機構。這類機構有時也稱為「評估機構」，有時間限制，且缺乏正式機構的可擴充性和彈性。

另請參閱「比較評估和付費機構」。

評估機構生命週期

評估機構的生命週期有限：

  1. 第 0 天：建立評估機構。
  2. 第 30 天：Google 會傳送電子郵件通知，提醒您即將到期。
  3. 第 60 天：Google 會刪除評估機構。

Google Cloud 層級架構中的 Apigee 機構

下圖顯示 Apigee 機構和環境，以及 Google Cloud 專案和資料夾之間的關係。

圖表：顯示 Google Cloud 機構階層中的 Apigee 機構

機構內的元件

下圖顯示 Apigee 組織模型的主要元件。 這個模型定義 API、API 產品、應用程式和應用程式開發人員在 Apigee 中的關聯。

階層式圖表：機構是 Apigee 部署作業的根層級。

這個模型不會顯示 Apigee 的所有功能，但會向您說明機構是部署作業的根目錄。

下表詳細說明機構模型的元件：

元件 說明
機構

每個 Apigee 機構都屬於單一 Google Cloud 專案，且每個專案最多只能包含一個機構。機構包含環境、API Proxy、API 產品、API 套件、應用程式和使用者。

帳戶持有人不限於單一機構。部分帳戶持有人可能會定義或成為多個機構的成員，這些機構支援不同的應用程式開發人員社群。
環境和環境群組

環境是組織內的獨立軟體環境，您可以在其中部署 API Proxy。您可以在機構中建立多個環境。

環境群組是一組環境，包含一或多個主機名稱。主機名稱是網址的一部分，用於呼叫 API Proxy，這些 Proxy 會部署至環境群組中的任何環境。

API Proxy

API Proxy 是傳入要求與後端服務之間的介面。Proxy 實體包含 Apigee 在處理用戶端要求和後端回應時執行的指令和政策。

API 產品

用於發布 API 的實體。API 產品會發布至開發人員入口網站，供外部開發人員使用。API 產品提供介面，可存取一或多個已發布的 API。介面 (可能使用 OpenAPI 規格說明) 可能包含一或多個 API Proxy 處理的 API 要求組合。

機構中的使用者會建立 API 產品。這麼做時，他們可以將任意中繼資料附加至每個 API 產品。其中一種常用的中繼資料類型可以定義服務方案，這類方案可指定 API 呼叫的存取限制、規定安全需求、允許監控和分析，以及提供其他功能。

Apigee 會收集 API 產品的數據分析資料。

API 供應商

建立及管理 API Proxy 和產品的人員或實體。用戶端應用程式開發人員可存取這些已發布的 API。

應用程式開發人員

機構組織包含一或多位開發人員，他們會建構應用程式，以使用機構組織定義的 API (以 API 產品形式發布)。開發人員可使用 API，但無法建立 API 或在機構中執行任何其他動作。

開發人員可以是貴公司內部人員、合作夥伴，也可以是外部開發人員，他們可能需要付費才能存取您的 API。您可以將開發人員視為使用您 API 的客戶。

開發人員必須先在貴機構註冊，才能註冊應用程式，並取得 API 金鑰或其他用戶端憑證，以存取您的 API。身為 API 提供者，您可以自行決定如何在機構中新增、更新或移除開發人員。您可以透過 UI 手動新增，建立開發人員入口網站，透過網站註冊，或使用 Apigee API 定義及實作自己的註冊機制。

Apigee 應用程式 (或應用程式)

Apigee 開發人員會建立一或多個使用您 API 的用戶端應用程式。

開發人員建立的用戶端應用程式會呼叫需要憑證檢查的 API (例如 API 金鑰或 OAuth 權杖)，因此必須先向貴機構建立應用程式註冊。應用程式註冊程序會提供 API 金鑰、金鑰/密碼組合或其他憑證給開發人員，用戶端應用程式呼叫 API 時必須使用這些憑證。

由於所有應用程式都會在貴機構中註冊，因此您可以使用 Apigee 監控應用程式，並收集應用程式及其 API 使用情形的分析資訊。

未顯示的 Apigee 其他元件包括 API 金鑰和 OAuth 權杖。

Apigee 支援不同類型的驗證，例如簡單的 API 金鑰、雙向 OAuth、三向 OAuth 等。

如果 API 供應商指定 API 金鑰驗證做為授權機制，用戶端應用程式就必須在每次向 API 提出要求時，一併傳遞 API 金鑰。如果該金鑰有效，Apigee 就會允許要求。或者，如果 API 供應商指定 OAuth 權杖驗證做為授權機制，用戶端應用程式必須先取得 OAuth 權杖，然後在每次向 API 發出要求時傳遞該權杖。如果權杖有效，Apigee 就會允許要求。您也可以使用其他自訂授權配置。

身為 API 供應商，您必須定義開發人員註冊應用程式的方式。每個應用程式註冊都會有一或多個相關聯的金鑰或憑證。如果您允許開發人員透過開發人員入口網站註冊自己的應用程式，開發人員就能透過便利的自助服務體驗，擷取存取 API 時所需的金鑰或憑證。

註冊應用程式時，開發人員可以選擇存取單一或多個 API 產品。開發人員的應用程式會使用同一組金鑰/憑證，存取與該應用程式相關聯的所有 API 產品。

您可以隨時撤銷金鑰，這樣一來，開發人員的應用程式就無法再存取您的 API (即使開發人員應用程式的註冊代表仍存在於貴機構中)。或者，您也可以撤銷開發人員的存取權，這樣一來，該開發人員註冊的所有應用程式憑證都會失效。撤銷作業可以復原。 Apigee 建立應用程式憑證時，您可以指定到期時間，讓開發人員在特定時間後必須取得新的金鑰或憑證。

Apigee 使用者

Apigee 使用者是機構的 API 團隊成員，包括管理員、API Proxy 和 API 產品建立者，或是監控數據分析和其他統計資料的使用者。使用者是使用 Apigee 開發人員建構應用程式的人員。在大多數情況下，本文件會使用「使用者」一詞來指稱 Apigee 使用者。

管理員可以將使用者新增至機構。

每位使用者可具備不同的角色和存取權限，舉例來說，您可以將部分使用者定義為機構管理員和營運管理員，授予他們修改機構及其元件的權限，並將其他使用者定義為有權建立 API Proxy 和 API 產品，但無權修改其他使用者的使用者。

使用者可以同時屬於多個機構。舉例來說，貴公司可能會在 Apigee 上定義多個機構，以支援不同的開發人員社群，即使內部人員建構所有 API Proxy 和 API 產品，因此是所有機構的成員，也是如此。

您不必建立 Apigee 機構，也能成為使用者。管理員可以將您新增至現有機構。

前往 Google Cloud 控制台的 Apigee 頁面。

前往 Apigee

授權與帳單

無論付費機構採用訂閱或即付即用計費模式，以下項目都會納入計費：環境、API 呼叫和 Proxy 部署。

訂閱方案可讓您預付授權費用，換取大幅折扣。如果用量較高 (例如環境數量較多、API 呼叫次數較多，或 Apigee 管理的 API Proxy 數量較多)，訂閱方案就比較划算。即付即用模式只會收取您使用的資源費用，但無法享有大量折扣。

訂閱項目授權

組織

您可以在任何 Google Cloud 專案中啟用 Apigee。 這樣做會為該專案建立 Apigee 機構。您可以視需要建立多個機構，建立 Google Cloud 專案不需要授權或付費，建立 Apigee 機構也不需要授權。
環境

環境的授權是以單位表示。使用環境單元授權時，需要經過兩個步驟：首先建立環境，然後將該環境附加至機構。環境連結至機構後，就會計入環境單位配額。如要瞭解單一機構的環境數量上限，請參閱「 限制」。

您可以選擇在一或多個可用的 Google Cloud 區域中建立 Apigee 環境。環境對應的每個區域都會耗用授權中的一個環境單位。在單一區域中佈建的環境會耗用您權益中的一個環境單位。在兩個區域中佈建的環境會耗用您權益中的兩個環境單位。環境單位總用量是所有機構使用的環境單位數總和。

您的環境單元總授權是訂閱方案提供的授權，加上透過環境套件取得的額外授權。

Google 會對環境強制執行授權，您無法超過授權限制。 如果您嘗試建立的環境超出授權限制，就會收到錯誤訊息。 您可以購買額外的環境套件，擴充授權。
API 呼叫

Google 會計算 Apigee 處理的每個 API 呼叫。您的 API 呼叫總配額是訂閱方案提供的配額，加上透過通話包取得的額外配額。

如果採用訂閱方案，Google 不會對 API 呼叫強制執行授權限制。如果超出 API 呼叫配額，Apigee 仍會繼續提供 API 呼叫服務，如果用量超出既有配額，Google 會向您收取費用。您可以隨時購買額外的通話套件，擴充 API 呼叫授權。
Proxy 部署作業

Google 會計算您部署的每個 API Proxy。您的代理伺服器部署總授權是訂閱方案提供的授權，加上透過代理伺服器部署套件取得的額外授權。

在訂閱方案中，Google 不會限制您部署的 Proxy 數量。如果您部署的 Proxy 超過授權允許的數量，Apigee 仍會允許您部署新的 Proxy，並繼續處理 API 呼叫。如果用量超出既有配額，Google 會向您收取費用。您可以購買額外的通話套件，擴充 Proxy 部署授權。

詳情請參閱「訂閱授權」。

即付即用授權

組織

您可以在任何 Google Cloud 專案中啟用 Apigee。 這樣做會為該專案建立 Apigee 機構。您可以視需要建立多個機構，建立 Google Cloud 專案不需付費，同樣地，在「隨用隨付」價格模式下，建立 Apigee 機構也不需付費。
環境

您可以將多個環境附加至 Apigee 機構。使用環境的程序分為兩個步驟：先建立環境，然後將該環境附加至機構。Google 會向您收取附加至機構的環境費用。

單一機構最多可建立 85 個環境。

如果是多區域環境，Google 會針對環境所在的每個區域向您收費。您可以選擇任何可用的 Google Cloud 區域。
API 呼叫

Google 會計算 Apigee 處理的每個 API 呼叫。Google 會根據 Apigee 環境處理的 API 呼叫數向您收費。沒有限制。Apigee 會自動調整資源配置，即使負載增加，仍會繼續處理 API 呼叫。
Proxy 部署作業

Google 會計算您部署的每個 API Proxy。Google 會根據 Apigee 環境中部署的 API Proxy 數量向您收費。

詳情請參閱「隨用隨付授權」。