API Connect 名詞解釋
IBM® API Connect 和 Cloud Manager 的術語與定義名詞解釋。
- 工具箱 (Toolkit)
- 請參閱「開發者工具箱 (Developer Toolkit)」。
- 可用性區域 (Availability zones)
- 資料中心中產生及運作公用雲端服務的隔離位置。企業會根據商業需要,為其服務選擇一或多個世界範圍的可用性區域。「可用性區域」透過提供跨區域備援,為服務提供高可用性。
- 可用性區域(主要)(Availability zone (primary))
- 對於 Kubernetes 表單係數,包含管理服務。其他區域可以包含其他服務(例如「Developer Portal」),但不能包含管理服務。
- 可見性 (Visibility)
- 設定可見性決定「提供者組織」是否可以存取「可用性區域」或其他服務。
- 用戶端 ID (client ID)
- 可用於識別個別應用程式的資訊片段。只有在應用程式傳遞 IBM API Connect 系統可辨識的應用程式金鑰,並獲授與 API 存取權時,才能呼叫 API。應用程式金鑰由用戶端透過 HTTP 查詢參數傳遞。
- 用戶端密碼 (client secret)
- 與應用程式金鑰並用的資訊片段,用於驗證應用程式的身分。API 可以配置成要求用戶端應用程式提供其用戶端密碼與用戶端 ID。用戶端密碼作為僅應用程式知道的密碼有效地起作用。用戶端密碼由用戶端透過 HTTP 查詢參數傳遞。
- 交互鑑別 (Mutual authentication)
- 在此程序中,網路上的兩個實體彼此鑑別。在網路環境中,用戶端鑑別伺服器,伺服器也會鑑別用戶端。它對於 TLS 而言是選用的。亦稱為雙向鑑別。
- 安全定義 (security definition)
- 指定 API 安全特定層面的所有設定;例如,用來鑑別 API 存取的使用者登錄。
- 成員(角色)(Member (role))
- 「管理者組織」及「提供者組織」中所有使用者的預設角色。系統會向所有使用者指派成員角色以及他們可能需要的其他角色。
- 伺服器 (server)
- 單一應用裝置,例如 IBM WebSphere IBM DataPower® 應用裝置。
- 冷待命 (Cold standby)
- 在此部署配置中,失效接手伺服器會處於已停止狀態,直到需要失效接手為止,導致需要較長時間才能還原解決方案的正常作業。
- 快速待命 (Hot standby)
- 在此部署配置中,有一組伺服器正在執行中,若發生故障,則隨時可以立即接管,但只有在該失效接手之後才主動處理資料流量。
- 角色 (role)
- 定義可以為使用者啟用功能的權限。每個角色都有一組不同的權限。
- 供應商延伸 (vendor extension)
- 特定使用案例所需 OpenAPI (Swagger) 規格的延伸。
- 服務 (service)
- 透過 API Connect 執行時期中的一個以上伺服器程序來實作的使用者可配置元素,例如微閘道、分析、IBM DataPower 及「Developer Portal」。
- 社群 (community)
- 一個消費者組織的集合。這在發佈 API 時,是一個群組的概念。社群用於限制 API 的顯示與存取設定。API 可以發佈至選取的社群,這表示只有那些組織內的應用程式開發者能夠查看 API。
- 社群管理員(角色)(Community Manager (role))
- 針對其所屬的「提供者組織」,管理應用程式開發者社群。
- 空間 (Space)
- 型錄的細分。每個空間由不同的 API 提供者開發團隊使用,而且具有專屬的管理功能集,這些功能專門與相關聯的團隊發佈至該空間的 API 相關,可讓每個團隊獨立管理其 API。
- 金鑰儲存庫 (Keystore)
- 安全憑證儲存庫、授權憑證或公開金鑰憑證及相對應的私密金鑰,用在 SSL 加密中。金鑰儲存庫檔具有
.jks副檔名。 - 信任儲存庫 (Truststore)
- 儲存來自授信憑證管理中心 (CA) 的憑證,用於驗證 SSL/TSL 連線中伺服器所提供的憑證。金鑰儲存庫儲存伺服器的認證,信任儲存庫儲存來自協力廠商 CA 的憑證。
- 型錄 (Catalog)
- 此暫置目標的行為像閘道的邏輯分割區及「Developer Portal」。API 呼叫及「Developer Portal」的 URL 是特定型錄的特有項目。
- 計劃 (Plan)
- API 用以供開發者使用的包裝建構。計劃提供來自一個以上 API 的作業集合,並且會發佈至應用程式開發者的社群。應用程式開發者可透過登錄應用程式來存取計劃,以取得 API 的存取權。計劃內含一組原則設定。在最簡單的形式中,計劃可定義單一配額原則,此原則會套用至所有透過計劃存取的 API 作業。在更進階的案例中,其他原則可以與計劃相關聯。
- 訂閱 (subscription)
- 應用程式開發者用以取得 API 所提供資源之存取權的方法。應用程式開發者使用「Developer Portal」來訂閱其中已發佈 API 的計劃。
- 原則 (policy)
- 此配置用來控制在執行時期處理 API 呼叫期間,「閘道」伺服器中的特定層面處理。原則是組件流程的建置區塊。原則提供一些方法來配置功能,例如安全、記載、遞送要求至目標服務,以及將資料從某種格式轉換成另一種格式。您可以在 API 或計劃的環境定義中配置原則。
- 消費者組織 (Consumer organization)
- 在型錄內,代表想要使用型錄所公開 API 的商業實體。例如,協力廠商應用程式開發公司會將其自身登錄為消費者組織(透過「Developer Portal」)。其公司中的每個開發者隨後可以登錄為該消費者組織內部的使用者。
- 區域 (Region)
- 實體位置(網站或資料中心),用於代管與其他位置隔離的基礎架構,具有獨立的電源和網路連線功能。區域不一定具有進一步的子隔離性質,例如半獨立艙或可用性區域。
- 產品 (Product)
- 提供一種方法,您可以透過該方法將 API 分組到旨在用於特定用途的套件。此外,它們包含計劃,可用來區分不同的供應項目。您只能在產品內建立計劃,然後在型錄中發佈這些產品。
- 組件 (assembly)
- 對外部服務進行端呼叫,然後轉換並聚集回應,再將回應轉送至發出呼叫的應用程式。
- 組織 (organization)
- 擁有 API 的實體,或使用 API 的應用程式。提供者組織擁有 API 及關聯的計劃,另外還可以擁有應用程式。消費者組織只擁有應用程式。組織至少有一個擁有者。組織可以是專案小組、部門或公司科處。
- 組織管理員(角色)(Organization Manager (role))
- 「組織管理員」管理「管理者組織」的「提供者組織」。
- 通知服務 (Notification services)
- 這些整合會提供通知功能,例如電子郵件。
- 通知設定 (Notification settings)
- 如何為 API Connect 使用者(API 提供者和消費者)配置通知。
- 通知範本 (Notification templates)
- 通知服務訊息格式和措辭的配置。
- 提供者組織擁有者 (Provider Organization Owner)
- 擁有和管理 API 提供者組織、管理應用程式開發者社群、編寫 API 和定義產品、管理 API 產品生命週期。「雲端管理者」邀請擁有者加入 API Connect,作為提供者組織的擁有者。
- 開發者(角色)(Developer (role))
- 針對其所屬的「提供者組織」,建立及配置 API、產品和原則。「API 開發者」可以是一個以上「提供者組織」的成員。「API 開發者」對 API 技術實作的著重程度,高於他們對與應用程式開發者的商業關係的著重程度。
- 開發者工具箱 (Developer Toolkit)
- 安裝在本端的套件,隨附的 API Designer 和
apic指令行工具可讓您建立、編輯、管理及發佈 API 和應用程式。 - 開發型錄 (Development Catalog)
- 此型錄用於測試開發中的 API,而且在此型錄中,執行發佈和生命週期動作無需核准。「非開發型錄」轉換為「開發型錄」時,會取消擱置中的核准。
- 傳輸層安全 (TLS)
- 傳輸層安全 - 此加密通訊協定可以在網路上提供安全通訊,以防止竊聽及竄改。它是 SSL 的繼任者,透過 TCP 執行。
- 微服務 (microservice)
- 透過 REST API 與其他微服務進行通訊的模組化、可獨立部署的應用程式服務。微服務通常圍繞著功能(例如建議、庫存、出貨或計費)進行組織。
- 資源(使用者登錄、TLS 設定檔、通知)(Resources (User registries, TLS Profiles, Notifications))
- 資源為 API Connect 雲端提供必要的功能,例如使用者鑑別、SSL 安全及傳送系統產生的電子郵件。
- 路徑 (Path)
- 定義使用者藉以存取 REST API 的路徑。路徑包含一個以上的 HTTP 作業,例如 GET 或 POST。
- 閘道 (Gateway)
- 請參閱「API 閘道」。
- 閘道服務 (Gateway service)
- 此 API Connect 服務提供 API 閘道功能,例如微閘道或 IBM DataPower。
- 管理伺服器 (Management server)
- 儲存所有雲端配置,並控制 API Connect 內其他伺服器之間的通訊。
- 管理服務 (Management service)
- 包含一個以上的「管理」伺服器。
- 整合 (Integrations)
- 以 API Connect 工作流程為建置基礎並改進此工作流程的協力廠商工具;例如 Slack 和 Auth0 等。
- 整合設定檔 (Integration profile)
- 可用來與管理服務整合以用於身分、通知和 API 分析等事項的標準 API。
- 應用程式 (Application)
- 使用(呼叫)API 的軟體。消費者組織登錄一個以上的應用程式以訂閱 API。系統會給應用程式配置該應用程式進行 API 呼叫時提供的用戶端 ID 和用戶端密碼認證。
- 叢集 (cluster)
- 提供特定功能的一個以上伺服器的集合。
- API Designer
- 此圖形工具在筆記型電腦或桌上型電腦系統本端執行,可讓您建立及修改 API 和 LoopBack® 應用程式,然後將其發佈至 IBM Cloud 或儲存器執行時期。
- API Manager
- API Connect 中的圖形工具,可讓您管理提供者組織、消費者組織和社群中的型錄、空間、API 及使用者和角色,將產品發佈至「Developer Portal」,以及分析 API 用量。
- API 作業 (API operation)
- 此 REST API 呼叫包含 HTTP 動詞和 URL 路徑(端點)。例如,
GET http://myserver.com/api/users會傳回一個使用者清單。 - API 事件 (API Event)
- 擷取供 API Connect Analytics 或協力廠商分析使用的事件,例如回應時間、HTTP 回應碼、要求與回應內文的內容等等。每次透過「閘道」伺服器呼叫 API 作業時,都會記載 API 事件。
- API 閘道 (API Gateway)
- 此服務用來作為提供者 API 和後端服務的單一進入點或者「前門」。「API 閘道」接受和處理並行 API 呼叫,以及執行資料流量管理、授權與存取控制、監視和 API 版本管理。另請參閱 #overview_apimgmt_glossary__dpgw。
- API 管理者(角色)(API Administrator (role))
- 針對其所屬的「提供者組織」,管理 API 產品生命週期。
- Developer Portal
- API Connect 的元件,為開發者提供可自訂的圖形 Web 入口網站來探索 API、登錄使用 API 的應用程式、訂閱使用計劃及測試和使用 API。
- LoopBack 資料來源 (LoopBack data source)
- 此 JavaScript 物件代表後端服務,例如資料庫、REST API(要使用)或 SOAP Web 服務。資料來源受連接器支援,而連接器會直接與資料庫或其他後端服務通訊。
- LoopBack 模型 (LoopBack model)
- 此 JavaScript 物件代表應用程式資料,並且包括驗證規則、資料存取功能和商業邏輯。依預設,LoopBack 模型提供一個 REST API,並連接至資料來源以存取後端資料。
- OAuth 提供者 (OAuth provider)
- OAuth 提供者為登入提供 OAuth 鑑別。API Connect 支援原生 OAuth 提供者及協力廠商 OAuth 提供者。部分共用協力廠商 OAuth 提供者為 Google 和 Facebook。
- OpenAPI 元件 (OpenAPI Components)
- API 規格的一部分,包含 API 規格各個方面的可重複使用物件集,例如綱目、回應、要求內文及標頭。如需相關資訊,請參閱 [OpenAPI 第 3 版規格](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#components-object)。
- Proxy
- 一種應用程式設計介面,可將要求轉遞至使用者定義的後端資源,並將回應轉送回發出呼叫的應用程式。
- SNMP
- 「簡易網路管理通訊協定 (SNMP)」是網路管理的熱門通訊協定。它用於從網路裝置收集資訊以及配置網路裝置,例如「網際網路通訊協定 (IP)」網路上的伺服器、印表機、中心、交換器及路由器。在 API Connect Cloud Manager 中配置 SNMP 主機。
- SSL (TLS) 設定檔 (SSL (TLS) Profile)
- SSL/TLS 設定檔用來保護透過網站的資料傳輸。SSL 憑證可保證您提交至網站的資訊不會遭竊或遭到竄改。
- TLS 設定檔 (TLS Profiles)
- Cloud Manager 和 API Manager 使用 TLS 設定檔來確保資料安全地透過網站進行傳輸。TLS 憑證可保證您提交至網站的資訊不會遭竊或遭到竄改。TLS 設定檔包含伺服器名稱、使用的通訊協定(SSL 或 TLS)以及是否需要「交互鑑別」。