本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
機構是 Apigee 中的頂層容器,Apigee 機構包含所有 API 代理程式和相關資源。本主題的其餘部分會更深入探討機構,以下提供幾個實用要點:
- Apigee 機構與 Google Cloud 機構不同,是後者的子公司。為 Apigee X 或 Apigee hybrid 建立機構時,會對應至單一 Google Cloud 專案,且 Apigee 機構和 Google Cloud 專案共用名稱。並非所有 Google Cloud 專案都有相關聯的 Apigee 機構。
- Apigee 說明文件使用「機構」一詞時,是指 Apigee 機構。Apigee 說明文件使用「Google Cloud 組織」一詞來指代替代方案。
- Apigee 機構一經建立即無法變更名稱。
- 您的 Apigee 機構名稱會顯示為 Google Cloud console 中 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。這些機構有時稱為評估機構,有時間限制,且缺乏正式機構的可擴展性和靈活性。
另請參閱「比較評估和付費機構」。
評估機構的生命週期
評估機構的生命週期有限:
- 第 0 天:建立評估機構。
- 第 30 天:Google 會傳送電子郵件通知,提醒您即將到期的期限。
- 第 60 天:Google 刪除評估機構。
Google Cloud 階層中的 Apigee 機構
下圖顯示 Apigee 機構和環境與 Google Cloud 專案和資料夾之間的關係。
機構內的元件
下圖顯示 Apigee 組織模型的主要元件。這個模型會定義 API、API 產品、應用程式和應用程式開發人員在 Apigee 中的關聯方式。
這個模型不會顯示 Apigee 的所有功能,但旨在讓您瞭解機構是部署作業的根目錄。
下表詳細說明組織模型的元件:
元件 | 說明 |
---|---|
機構 |
每個 Apigee 機構都屬於單一 Google Cloud 專案,且一個專案最多只能包含一個機構。機構包含環境、API Proxy、API 產品、API 套件、應用程式和使用者。 帳戶持有人可以隸屬於多個機構。部分帳戶持有人可能會定義或加入多個機構,以支援不同的應用程式開發人員社群。 |
環境和環境群組 | 環境是指組織內的隔離軟體環境,您可以在其中部署 API Proxy。您可以在機構中建立多個環境。 環境群組是一組含有一或多個主機名稱的環境。主機名稱是用於呼叫 API Proxy 的網址一部分,可部署至環境群組中的任何環境。 |
API Proxy |
API Proxy 是傳入要求與後端服務之間的介面。Proxy 實體包含 Apigee 處理來自用戶端的要求和來自後端的回應時執行的指示和政策。 |
API 產品 |
用於發布 API 的實體。API 產品會發布至開發人員入口網站,供外部開發人員使用。API 產品會提供介面,讓您存取一或多個已發布的 API。介面 (可使用 OpenAPI 規範加以描述) 可能包含一或多個 API 要求的組合,這些要求會由一或多個 API Proxy 處理。 機構中的使用者會建立 API 產品。這樣一來,他們就能為每個 API 產品附加任意中繼資料。一種常用的中繼資料類型可定義服務方案,可指定 API 呼叫的存取限制、規定安全性要求、允許監控和分析,並提供其他功能。 Apigee 會收集資料,以便分析 API 產品。 |
API 供應器 |
建立及管理 API Proxy 和產品的人員或實體。用戶端應用程式開發人員可存取這些已發布的 API。 |
應用程式開發人員 |
機構組織包含一或多位開發人員,他們會建構應用程式,以便使用機構組織定義的 API (以 API 產品形式發布)。開發人員可以使用 API,但無法在機構中建立 API 或執行任何其他操作。 開發人員可能是貴公司的內部人員、合作夥伴,或是外部開發人員,他們可能會為存取 API 付費,也可能不會。您可以將開發人員視為使用 API 的客戶。 開發人員必須先在貴機構中註冊,才能註冊應用程式,並取得 API 金鑰或其他用戶端憑證,以便存取您的 API。身為 API 供應商,您可以自行決定如何在貴機構中新增、更新或移除開發人員。您可以透過使用者介面手動新增這些項目、建立開發人員入口網站以便透過網站註冊,或是使用 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 產品。
您隨時可以撤銷金鑰,讓開發人員的應用程式不再存取您的 API (即使開發人員應用程式的註冊表示法仍存在於貴機構中)。或者,您也可以撤銷開發人員的授權,這樣一來,為該開發人員註冊的所有應用程式都會無法使用所有憑證。撤銷後可以復原。 在 Apigee 建立應用程式憑證時,您可以指定到期日,讓開發人員必須在特定時間後取得新的金鑰或憑證。
Apigee 使用者
Apigee 使用者組成機構的 API 團隊,其中可能包括管理員、API 代理和 API 產品建立者,或是監控數據分析和其他統計資料的使用者。使用者是指使用 Apigee 開發人員所建構應用程式的使用者。在大多數情況下,本文件會使用「使用者」一詞來指 Apigee 使用者。
管理員可以將使用者新增至機構。
不同使用者可具備不同的角色和存取權限。舉例來說,您可以將部分使用者定義為機構管理員和作業管理員,授予修改機構及其元件的權限,並將其他使用者定義為可建立 API Proxy 和 API 產品,但沒有修改其他使用者的權限。
使用者可以同時是多個機構的成員。舉例來說,貴公司可能會在 Apigee 中定義多個機構,以便支援不同的開發人員社群,即使在內部,同一位使用者也可能會建構所有 API 代理程式和 API 產品,因此是所有機構的成員。
您不必建立 Apigee 機構,也能成為使用者。管理員可以將您加入現有機構。
所有使用者都會登入 Apigee 的以下位置:Cloud 控制台中的 Apigee UI。
授權和帳單
無論付費機構採用的是訂閱或即付即用定價模式,用於計費的項目都是:環境、API 呼叫和 Proxy 部署。
訂閱方案可讓您預先支付授權費用,換取大幅折扣。訂閱方案適用於使用量較高的情況,例如有更多環境、大量 API 呼叫,或是由 Apigee 管理的大量 API 代理程式。在即付即用的模式下,您只需為使用的資源付費,但無法享有大量折扣。
訂閱項目授權
組織 |
您可以在任何 Google Cloud 專案中啟用 Apigee。 這樣做會為該專案建立 Apigee 機構。您可以建立任意數量的機構,建立 Google Cloud 專案不需要授權或付費,建立 Apigee 機構也沒有授權要求。 |
---|---|
環境 |
環境的授權是以單位表示。使用環境單位授權的程序分為兩個步驟:首先建立環境,然後將該環境附加至機構。當環境連結至機構時,該環境會計入您的環境單位授權。如要瞭解單一機構的環境數量上限,請參閱「 限制」一節。 您可以選擇在一個或多個可用的 Google Cloud 區域中建立 Apigee 環境。每個對應至環境的區域都會消耗您授權的一個環境單位。在單一地區中佈建的環境會消耗您授權的一個環境單位。在兩個區域中佈建的環境會消耗您授權的兩個環境單位。環境單位總用量是指所有機構使用的環境單位數量總和。 您的環境單元授權總數,是訂閱層級提供的授權總數,加上透過環境包取得的額外授權總數。 Google 會強制執行環境的授權,因此您不得超出授權限制。 如果您嘗試建立超出授權限制的環境,系統會傳回錯誤。您可以購買額外的環境包來擴充授權。 |
API 呼叫 |
Google 會計算 Apigee 處理的每個 API 呼叫。您的 API 呼叫授權總數,是訂閱層級提供的授權總數,加上透過 Call Pack 取得的額外授權。 在訂閱方案下,Google 不會強制執行 API 呼叫的授權限制。如果您超出 API 呼叫授權,Apigee 仍會繼續提供 API 呼叫。Google 會針對超出現有授權的用量向您收費。您隨時可以購買額外的 Call Pack,擴充 API 呼叫授權。 |
Proxy 部署作業 |
Google 會計算您部署的每個 API Proxy。您的總 Proxy Deployment 授權是訂閱層級提供的授權總和,加上透過 Proxy Deployment 套件取得的額外授權。 在訂閱方案中,Google 不會限制代理程式部署作業的授權。如果您部署的 Proxy 數量超過授權,Apigee 仍會允許您部署新的 Proxy,並繼續提供 API 呼叫。Google 會針對超出現有授權的用量向您收費。您可以購買額外的呼叫套件,擴充 Proxy Deployment 授權。 |
詳情請參閱「訂閱授權」。
即付即用授權
組織 |
您可以在任何 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 數量向您收費。 |
詳情請參閱「按使用付費授權」。