API Gateway

API Gateway,提供高效能、高可用 API 託管服務,用戶只需簡單動作,即可快速、低成本、低風險的開放資料或服務。

立即開通 聯絡我們

API Gateway

API Gateway為您提供完整的 API 託管服務,輔助用戶將能力、服務、資料以 API 的形式開放給夥伴。

  • 提供防惡意探索、防重放、要求加密、身份認證、權限管理、流量控制等多重手段許諾 API 安全,降低 API 開放風險。

  • 提供 API 定義、測試、發佈、下線等全生命週期管理,並生成 SDK、API 說明文件,升階 API 管理、迭代的效率。

  • 提供便捷的監控、報警、剖析等運維、運營工具,降低 API 運營、維修成本。

API Gateway將能力的複用率最大化,企業間能夠互相借力,企業發展能夠專註自身商務,實現共贏。

優點

解放生產力

完成 API 錄入後,即可告別 API 管理的一切繁雜,API Gateway為您解決 API 文件維修、SDK維修、API 組建管理等繁瑣交易,大大降低您的日常維修成本。

只為實際服務付費

免費開通,API 日常管理、生成文件、生成 SDK、流量控制、權限控制,均不需要付費。您只需為 API 的實際叫用付費。

大級別且高效能

API Gateway採用散發式部署,自動擴充,能夠裝載大級別的 API 存取;同時還能許諾較低的延時,為您的後端服務提供高保障高效率的網關功能。

安全穩定

您的服務只需在內網對 API Gateway開放,不必顧慮安全問題。API Gateway還提供嚴格的權限管理功能、精準的流量控制功能、全面的監控報警功能,讓您的服務安全、穩定、可控。

產品詳情

下面為 API Gateway產品主要功能點。


功能

API 生命週期管理

  • 支援包括 API 發佈、API 測試、API 下線等生命週期管理功能。

  • 支援 API 日常管理、API 組建管理、API 快速復原等維修功能。

全面的安全防護

  • 支援多種認證方式,支援 HMAC (SHA-1,SHA-256) 演算法簽章。

  • 支援 HTTPS 合約,支援 SSL 加密。

  • 防惡意探索、防注入、要求防重放、要求防篡改。

靈活的權限控制

  • 用戶以 APP 作為要求 API 的身份,網關支援針對 APP 的權限控制。

  • 只有已經獲得授權的 APP 才能要求相應的 API。

  • API 提供者可以主動授權某個 APP 叫用某個 API 的權限。

精準的流量控制

  • 流量控制可以用於管控 API的被存取頻率、APP的要求頻率、用戶的要求頻率。

  • 流量控制的時間單位可以是分鐘、小時、天。

  • 同時支援流控例外,允許設定特殊的 APP 或者用戶。

要求校驗

  • 支援參數類型、參數值(範圍、列舉、正則、Json Schema)校驗,無效校驗直接會被 API Gateway拒絕,減少無效要求對後端造成的資源浪費,大大降低後端服務的處理成本。

資料轉換

  • 通過設定對應規則,實現前、後端資料翻譯。

  • 支援前端要求的資料轉換。

監控報警

  • 提供視覺效果的API即時監控,包括:叫用量、流量大小、回應時間、錯誤率,在陸續增加維度。

  • 支援曆史情況查詢,以便統籌剖析。

  • 可設定通知方式(SMS、Email),訂閱通知資訊,以便即時掌握API執行情況。

自動工具

  • 自動生成 API 文件,可供線上查看。

  • API Gateway提供多種語言 SDK 的樣本。降低 API 的運維成本。

  • 提供視覺效果的介面偵錯工具,快速測試,快速上線。

場景

API Gateway能夠支架您在各個場景下開放 API 的需求,支援將 API 開放給夥伴、開發人員,實現企業核心能力的貨幣化,建立 API 生態;支援將 API 適配多端,如:移動、互連網、物聯,實現系統前後端分離;支援內部系統整合模組化、微服務化。

1,建立 API 生態,互相借力,協同發展

面對用戶日益膨脹而又分散化的需求,企業需要不斷探索新的商業圖樣,來解決客戶一列車的場景化問題。通過API Gateway提供標準的 API 服務,讓其他開發人員將不同 API 服務群組整合到自己的套用中,衍生出新的服務,促進企業建立商業生態、跨界創新。

  • 通過 API Gateway將企業的核心能力,開放給夥伴,達成深度合作,協同發展;

2,安全的實現多端統一,一套服務,多端輸出

隨著移動、物聯網的普及,API 需要支援其他的終端裝置,以擴充商務級別,但同時也帶來系統複雜性的升階。通過 API Gateway可以使 API 適配多端,企業只需要在 API Gateway調整 API 定義,無需做額外工作。

  • 企業只需維修一個服務體系,面向多端輸出,只需調整API定義,即可實現對APP、裝置、web端等多種終端的支援;

  • 避免多個場景多套API,大大降低管理運維成本。

3,輕鬆實現系統整合,正常化、標準化

  • 通過 API Gateway對系統間介面進行規格統一,用標準化的介面實現系統整合;

  • 快速完成資源整合和管理,關閉快速發展造成的冗餘和浪費,聚力發展商務。

價格

API Gateway僅對開放API的用戶按下述既價格格收費。

API Gateway 計費分兩個維度:叫用量(次數)、流量。兩個維度有各自的計費規則,同時計費。

API Gateway支援免費開通服務、免費建立API、免費發佈API、免費管理API。

當API被叫用時,所產生的叫用量(次數)和流量將同時計入收費。

按【叫用量(次數)】計費說明

開通網關服務後,第一年每月(自然月)前一百萬次叫用免費,當月超過部份按照下表階梯計費。

按階梯計費月累計超過次數單位:美元/百萬次
第一階梯0~1000萬(包含)0.9
第二階梯1000萬~1億(包含)0.6
第三階梯1 億以上0.45

按叫用量(次數)計費說明:

a) 計費項:API叫用量(次數)

b) 計費方式:按量後付費

c) 計費周期:月

d) 帳單時間: 帳單出賬時間通常在本期計費周期結束後一小時內,最長不超過三個小時

e) 計費幣種:美元

f) 有效叫用次數: API Gateway收到的所有API要求,均為有效叫用,會計入收費範圍

按【流量】計費說明

按照下行流量計費,流量價格如下表:

計費項價格單位中國大陸香港亞太東南1(新加坡)亞太東南 3 (吉隆坡)歐洲中部 1 (法蘭克福)亞太南部 1(孟買)亞太東南 5 (雅加達)
流量(下行流量)美元/GB0.1250.1560.1170.1120.070.0770.117

按流量計費說明:

a) 計費項:流量費用(下行流量)

b) 計費方式:按量後付費

c) 計費周期:月

d) 帳單時間: 帳單出賬時間通常在本期計費周期結束後一小時內,最長不超過三個小時

e) 計費幣種:美元

f) 若您的後端服務與API Gateway不在同一區域,或後端服務不在阿里雲,我們將會額外收取API Gateway到您後端服務的流量費用。收費標準同上表

使用須知

A. 服務暫停

欠費後,則您的API將停止被叫用(API管理相關動作可以進行),並會以SMS/郵件的方式提醒您續費。

B. 服務復原

服務被暫停後半年內,您成功儲值後,服務可自動開啟,並繼續使用。超過半年,API Gateway將有權清理您API設定資訊。

使用入門

本頁內容對 API Gateway提供的文件進行說明,方便您儘快找到對應的說明文件。

您可以通過 API Gateway開放 API,也可以通過 API Gateway要求他人開放的 API。

您在查看文件時,請注意區分使用目的。

若您使用 API Gateway開放 API,請查看:

使用手冊(開放 API) 快速入門(開放 API)

若您使用 API Gateway要求他人開放的 API,請查看:

使用手冊(叫用 API) 快速入門(叫用 API)

當然,您可以通過 API Gateway的 API 和 SDK 來使用產品。

現在就開始錄入 API 吧!

資源

下面提到的 API 和 SDK 是由 API Gateway對外提供的介面和工具,您可以通過這些使用 API Gateway產品,取代您在 API Gateway主控台的動作。

請將下方 API 與用戶在 API Gateway開放的 API 進行區別,同時用於要求他人開放 API 的 SDK 請前往主控台SDK 下載網頁查看。

前往主控台下載 SDK

開發人員資源

常見問題

1. 產品有什麼使用節流?

請參照產品使用節流相關文件:

使用節流(叫用 API) 使用節流(開放 API)

2. 是否需要額外購買安全產品?

取決於您API的安全要求。API Gateway會為您解決 API 開放程序中的基本安全問題,包括對要求者進行身份認證、要求加密、要求防篡改等等。若您有更高的安全要求,需要結合其他安全產品使用。

3. 是否需要為 API Gateway購買 SLB?

API Gateway會為您解決從用戶端到網關的負載平衡,網關自身會根據要求量自動擴充。若您後端服務為多台 Ecs,則多台 Ecs 之間可通過 Slb 實現負載平衡。

4. 使用產品欠費會怎麼樣?

API Gateway是後付費產品,若您有帳單未能及時結算,則 API Gateway認為您為欠費狀態。欠費期間您的 API 服務將被禁止叫用,欠費時間達到6個月,則 API Gateway有權移除您的設定資訊。

5. 為什麼 API Gateway無法調通我的後端服務?

請檢查您錄入的後端服務位址是否正確。

許諾您的後端服務可以正常存取。

如後端服務在 Ecs ,請檢查安全性群組設定,是否可以被外部存取。請許諾安全性群組允許 API Gateway的 IP 段存取。

IP 段查詢

如果後端服務位址是內網 IP ,請許諾您的後端服務與您的 API 處於同一Region。

6. 用戶傳入一個未定義的參數,API Gateway會如何處理?

API Gateway會將該參數拋棄,不會傳遞給後端服務。

7. 是否支援 HTTPS 合約?

可以,在錄入後端服務位址時,請以“ https:// ”開頭,且需要許諾您的後端服務 SSL 憑證有效。

8. API 發佈是否有延時?

即時生效,請謹慎動作。

9. API Gateway監控功能的時效性?

基本是即時的監控資訊,最大延遲不超過1分鐘。

10. 如何選擇分組的Region?

請盡量選擇和後端的ECS、Docker相同的地域。

11. 分組的次層網域是什麼?有何節流?

分組的次層網域是 API Gateway配置給每個 API 分組的,只能用於 API 測試叫用的階段,不建議對外開放該次層網域。該分組下的所有 API 共用同一個次層網域。直接存取次層網域要求 API 的話,每天的存取上限是 1000 次。

12. 硬地網域名稱是什麼?

如果您要對外開放 API 服務,您需要給 API 所在分組繫結硬地網域名稱。其他人叫用您開放的 API 服務需要存取該硬地網域名稱。硬地網域名稱可以是某個網域名稱的二級、第三層網域名,繫結前需要先 CNAME 解析到分組的次層網域上。

13. 如何許諾網關到後端伺服器的叫用安全?

您可以在 API Gateway設定後端簽章金鑰,亦可使用 HTTPS 對要求進行加密。

後端簽章金鑰

14. 更換後端金鑰是否需要發佈API?

不需要,您只需要建立新的金鑰,然後繫結到 API 上即可。

15. 如何不中斷服務更換後端金鑰?

由於金鑰與 API 繫結後即時生效,要想不間斷的完成金鑰更新,需要您後端先同時支援新舊兩個金鑰,更換完畢後再結束對舊金鑰的支援。

16. APP 是什麼?

APP 是由要求者建立的,作為要求 API 服務的身份。每個 APP 有 AppKey 和 AppSecret,這對金鑰參與要求簽章。API Gateway面向 APP 做簽章驗證和權限驗證。

17. 如何?權限控制?

在 API Gateway要求 API 服務需要建立 APP 作為要求者的身份,要求者只有獲得開放者的授權或者購買了 API 服務才有權要求 API。

18. API 呼叫失敗?

請依次檢查下屬各項:

  • 檢查網域名稱是否解析;

  • 檢查網域名稱是否已經繫結到分組;

  • 檢查API是有發行;

  • 檢查使用的AppKey是否被授權;

  • 後端服務位址是否正確,是否能正常存取;

  • 檢查逾時時間設定是否正確,請確保後端服務在設定的逾時時間內返回;

  • 檢查是否超出超出流控節流。

錯誤資訊查詢請參照文件

錯誤碼錶