瞭解機構

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

機構是 Apigee Edge 中的頂層容器，其中含有您的所有 API Proxy 和相關資源雖然本主題其餘部分會深入介紹機構 以下提供幾個實用的要點：

  • 根據預設，您的機構名稱會在用來呼叫 API Proxy 的網址中，如 如「虛擬主機簡介」中所述。 例如： 
    http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
  • 您的機構名稱位於 Edge 管理 UI 的網址中。舉例來說，以下網址會顯示 docs 機構的 API Proxy：

    在網址 apigee.com/organizations/docs/proxies 中，/docs/ 是以圓圈表示。

  • 雖然你只能建立一個機構，但你仍屬於其他機構， 以管理客戶或管理員位於 Edge 管理 UI 中 (如果您隸屬於) 您可以將多個機構轉換成其他機構，詳情請參閱「切換機構」。

  • 以機構管理員的身分使用 Management API 呼叫時 角色，機構是大多數呼叫路徑中不可或缺的一環。例如，下列 Management API cURL 要求會傳回機構內所有 API Proxy 的清單： 
    curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address

影片：觀看這部短片，瞭解機構如何支持 適用於 API 管理的多用戶群架構

機構元件

當您建立 Edge 帳戶時，Edge 會自動為您建立機構。一次 管理員可在貴機構中新增使用者 建立 API Proxy 和 API 產品 註冊開發人員和應用程式

下圖顯示 Edge 機構模型的主要元件。這個 模型定義了 API、API 產品、應用程式和應用程式開發人員在 邊緣

流程圖顯示環境、使用者、API 產品和開發人員之間的關係 應用程式、API 金鑰/OAuth 權杖和 API Proxy。

這個模型不會顯示 Apigee Edge 的所有功能。如果您使用營利 模型就會有其他元件若需更多資訊，請參閲 營利總覽。詳情請見 管理公司和開發人員 ，瞭解如何運用營利服務管理公司和開發人員。

機構名稱

機構名稱如下：

  • 評估機構： username-eval
  • 付費機構：初次佈建時的使用者定義

機構建立後即無法重新命名。

機構名稱會成為 API Proxy 網址的一部分，而且當 向 Edge Management API 發出要求。例如：用來存取 API 的一般網址 格式如下：

http://org-name-env.apigee.net/v1/weather/forecastrss

其中：

  • org-name 是貴機構的名稱。
  • env 是 API Proxy 的部署環境，可以是測試或 正式環境

例如：

http://myorg-test.apigee.net/v1/weather/forecastrss

機構元件

下表詳細說明瞭機構模型的組成：

元件 說明

機構

每個 Apigee 帳戶都會對應至 Apigee Edge 上的一或多個機構。 機構內含所有元件的表示法，包括 API Proxy、API 產品、API 套件、應用程式和開發人員

帳戶持有人不限於單一機構。部分帳戶持有人可能會 定義或屬於多個機構的成員，這些機構支援不同的應用程式開發人員 社群。
環境 機構中 API Proxy 的執行階段執行環境。請參閱這一節 請參閱下文

使用者

機構內，建立帳戶的使用者會自動 可以建立更多使用者使用者由機構組織的 API 團隊組成 管理員、API Proxy 和 API 產品建立者等人員 以及監控數據分析和其他統計資料等等。

每位使用者可以擁有不同的角色和存取權限。舉例來說 部分使用者擔任「機構管理員」和「作業管理員」且具備相關權限 以修改機構及其元件定義其他具備下列權限的使用者： 建立 API Proxy 和 API 產品，但無權修改其他 使用者。

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

無須建立 Apigee 帳戶，也就是建立 Apigee 轉換成使用者管理員可以將您加入現有的 並根據貴機構的使命 價值觀和目標進行調整

所有使用者都會從下列位置登入 Apigee Edge： https://enterprise.apigee.com.

API Proxy

機構中的使用者會建立一或多個 API Proxy。API Proxy 會定義 將公開可用的 HTTP 端點對應至後端服務。API Proxy 也可以 包括安全性 (例如 OAuth)，執行訊息轉換 (例如 例如從 XML 到 JSON)、限制後端服務的流量，以及執行其他有價值的作業 回應及服務呼叫。

Edge 會收集 API Proxy 的資料以進行分析。

API 產品

機構中的使用者建立了一或多項 API 產品，而 API 產品是指 包含一組 API Proxy 和服務方案。該項服務方案可以設定存取權 提供 API Proxy 限制、提供安全防護、允許監控與分析，以及 其他功能

Edge 會收集 API 產品的資料進行分析。

開發人員

機構是指一或多位開發人員，他們打造的應用程式會使用 API (組合成 API 產品)。開發人員使用 API 但無法在機構中建立 API 或執行任何其他動作。

開發人員可以是公司內部、合作夥伴，也可以是 付費存取 API 的外部開發人員。

開發人員必須先在機構中註冊，才能註冊應用程式並 接收 API 金鑰以存取您的 API。API 供應商可自行決定 如何新增、更新或移除貴機構的開發人員。您可以手動新增 透過 Edge Management UI 建立開發人員入口網站，以便透過 ，或使用 Edge 管理機制自行定義註冊機制 也能使用 Google Cloud CLI 或 Compute Engine API

開發人員不一定要擁有 Edge 帳戶，且大部分開發人員都不需要 所有 Edge 都不需要知道如果開發人員擁有 Edge 帳戶，則 或要使用 Edge API 服務。

應用程式

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

開發人員必須在貴機構註冊應用程式。Edge 中的應用程式 開發人員的實際應用程式示意圖，為開發人員提供 API 金鑰 傳入您的 API 中。

所有應用程式都已在機構中註冊，因此您可以使用 Edge 監控及 收集分析資料以及應用程式使用 API 的分析資料。

API 金鑰/OAuth 權杖

視您為 API 定義的授權機製而定，應用程式會傳送 API 金鑰以及每個對 API 發出的要求。如果這個金鑰有效，請求就會是 。Edge 支援不同類型的驗證，例如簡單的 API 金鑰 雙足式 OAuth、三足式 OAuth 等等

API 供應商必須定義讓開發人員註冊應用程式的方式。是 註冊應用程式，然後您會返回開發人員，取得存取 相互整合

在應用程式註冊時，開發人員可以選擇使用單一 API 一或多個 API 產品開發人員的實際應用程式會使用同一組金鑰存取應用程式 所有與應用程式相關聯的 API 產品 (註冊使用的表示法 開發人員的應用程式)。

您隨時可以撤銷金鑰，讓開發人員的應用程式失去存取權 傳遞至 API (即使開發人員應用程式的註冊表示法 必須存在於您的機構中)。或者，您也可以為金鑰定義時間限制， 開發人員必須在特定時間過後重新整理金鑰。

關於環境

環境是機構中 API Proxy 的執行階段執行環境。 您必須先將 API Proxy 部署至環境，才能存取該環境。如有需要 可連結單一環境或多個環境

一個機構可以包含多個環境。例如，您可以定義 dev 機構中的 test 和 prod 環境。

機構提供了部分 Apigee 功能的範圍。例如：鍵/值對應 (KVM) 資料可在機構層級使用，也就是說，將 API Proxy 部署至任何 KVM 也會從 KVM 取得相同的資料快取等部分功能可限定範圍 或是機構內部的特定環境 Apigee 數據分析資料會依機構和環境的組合分區。

下方顯示的是您在機構中管理的主要實體，包括 部署於單一環境，且專為環境定義的：