什么是API網(wǎng)關(guān)
產(chǎn)品功能
API生命周期管理
包括API的創(chuàng)建、發(fā)布、下線和刪除的完整生命周期管理功能。通過API生命周期管理功能，您可以快速、高效的開放成熟的業(yè)務(wù)能力。
云原生網(wǎng)關(guān)
API網(wǎng)關(guān)將流量入口和微服務(wù)治理能力融合，用一個(gè)網(wǎng)關(guān)去同時(shí)支持了k8s Ingress和Gateway API的功能，不僅大幅提升了性能，還簡(jiǎn)化了架構(gòu)，降低了部署和運(yùn)維成本。
便捷調(diào)試工具
API網(wǎng)關(guān)提供頁面調(diào)試工具，您可以使用該工具添加HTTP頭部參數(shù)與body體參數(shù)，對(duì)API進(jìn)行調(diào)試，簡(jiǎn)化API開發(fā)，降低API的開發(fā)維護(hù)成本。
版本管理
API可以發(fā)布到不同的環(huán)境，如果您需要再次發(fā)布此API到之前已發(fā)布的環(huán)境，那么此次的發(fā)布版本將立即覆蓋之前的版本。API網(wǎng)關(guān)支持查看API發(fā)布?xì)v史（如版本、發(fā)布說明、發(fā)布時(shí)間和發(fā)布環(huán)境），并支持回滾到任一API歷史版本，以便滿足業(yè)務(wù)灰度發(fā)布、版本升級(jí)、回滾等需求。
環(huán)境變量
環(huán)境變量是指在環(huán)境上創(chuàng)建可管理的一種變量，該變量固定在環(huán)境上。當(dāng)API發(fā)布到不同環(huán)境時(shí)，發(fā)布過程中變量標(biāo)識(shí)會(huì)被相應(yīng)環(huán)境的變量值替換，API本身定義不變。通過創(chuàng)建環(huán)境變量，實(shí)現(xiàn)同一個(gè)API，在不同環(huán)境中調(diào)用不同的后端服務(wù)。
流量控制
針對(duì)不同的業(yè)務(wù)等級(jí)、用戶等級(jí)，可實(shí)施API的請(qǐng)求頻率、用戶的請(qǐng)求頻率、憑據(jù)應(yīng)用的請(qǐng)求頻率和源IP的請(qǐng)求頻率的管控，用于保障后端服務(wù)的穩(wěn)定運(yùn)行。
流量控制的時(shí)間單位可以是秒、分鐘、小時(shí)或天。
允許設(shè)置特殊的應(yīng)用和租戶。
監(jiān)控告警
提供實(shí)時(shí)、可視化的API監(jiān)控，包括：API請(qǐng)求次數(shù)、API調(diào)用延遲和API錯(cuò)誤信息，通過監(jiān)控面板更清晰地了解API的調(diào)用情況，識(shí)別可能影響業(yè)務(wù)的潛在風(fēng)險(xiǎn)。
訪問控制
訪問控制策略是API網(wǎng)關(guān)提供的API安全防護(hù)組件之一，主要用來控制訪問API的IP地址和賬戶，您可以通過設(shè)置IP地址或賬戶的黑白名單來允許/拒絕某個(gè)IP地址或賬戶訪問API。
VPC通道
在API網(wǎng)關(guān)中創(chuàng)建VPC通道來訪問VPC環(huán)境中的資源，并將部署在VPC中的后端服務(wù)開放API。同時(shí)VPC通道具有負(fù)載均衡功能，從而實(shí)現(xiàn)后端服務(wù)的負(fù)載均衡。
簽名密鑰
簽名密鑰是由一對(duì)Key和Secret組成，簽名密鑰需要綁定到API才能生效。簽名密鑰用于后端服務(wù)驗(yàn)證API網(wǎng)關(guān)的身份，在API網(wǎng)關(guān)請(qǐng)求后端服務(wù)時(shí)，保障后端服務(wù)的安全。
模擬響應(yīng)
API網(wǎng)關(guān)支持設(shè)置模擬的API后端響應(yīng)，支持利用Mock響應(yīng)支持重定向等場(chǎng)景。
開放API流程
作為API提供者，您可以將成熟的業(yè)務(wù)能力（服務(wù)、數(shù)據(jù)等）作為后端服務(wù)，在API網(wǎng)關(guān)中開放API，并通過線下或線上方式提供給API調(diào)用者使用，實(shí)現(xiàn)業(yè)務(wù)能力變現(xiàn)。
調(diào)用API流程
作為API調(diào)用者，您可以獲取并調(diào)用API提供者在API網(wǎng)關(guān)開放的API，減少開發(fā)時(shí)間與成本。
API網(wǎng)關(guān)常見問題
API網(wǎng)關(guān)常見問題
-
API網(wǎng)關(guān)是否支持多后端節(jié)點(diǎn)方案？
支持，通過VPC通道（負(fù)載通道）支持多后端節(jié)點(diǎn)，一個(gè)VPC通道中可以添加多個(gè)云服務(wù)器。
-
獨(dú)立域名申請(qǐng)后，還需要做什么
獨(dú)立域名完成注冊(cè)、備案后，對(duì)于專享版，您需要將其A記錄解析到實(shí)例的入口地址。解析成功后，即可使用。域名與API分組為多對(duì)一的關(guān)系，即一個(gè)分組最多能綁定5個(gè)獨(dú)立域名，但一個(gè)域名只能解析到1個(gè)分組。
-
API調(diào)用失敗的可能原因有哪些？
網(wǎng)絡(luò)問題：同一VPC內(nèi)調(diào)用失敗、不同VPC之間調(diào)用失敗、公網(wǎng)調(diào)用失敗。
域名問題：域名是否備案成功，且能正常解析。
發(fā)布問題：修改后的API是否重新發(fā)布。
API控制策略問題：是否超過了流量控制范圍。
更多詳情請(qǐng)前往了解更多。
-
No backend available，怎么解決？
檢查后端服務(wù)是否可以訪問，如果不能訪問，請(qǐng)修改后端服務(wù)。
檢查后端服務(wù)對(duì)應(yīng)的ECS安全組配置，查看是否已開放您需要的端口。
檢查VPC網(wǎng)絡(luò)中的ACL配置，查看是否有相關(guān)ACL策略限制了API網(wǎng)關(guān)實(shí)例與后端服務(wù)所在子網(wǎng)的通信。
若使用VPC通道，檢查VPC通道業(yè)務(wù)端口、健康檢查端口、后端服務(wù)器添加是否均正常。
-
是否支持HTTPS的雙向認(rèn)證？
前端雙向認(rèn)證。在綁定獨(dú)立域名時(shí)，選擇帶有CA證書的SSL證書，默認(rèn)開啟客戶端認(rèn)證即雙向認(rèn)證。
后端雙向認(rèn)證。在創(chuàng)建API時(shí)，配置雙向認(rèn)證，在API網(wǎng)關(guān)和后端服務(wù)間啟用雙向認(rèn)證。配置請(qǐng)參考創(chuàng)建API中的“TLS雙向認(rèn)證”參數(shù)說明。
-
“無認(rèn)證”方式的API該怎么鑒權(quán)與調(diào)用？
“無認(rèn)證”即API網(wǎng)關(guān)對(duì)收到的調(diào)用請(qǐng)求不做身份認(rèn)證，您只需要按照API提供者提供的接口說明，封裝規(guī)范的HTTP請(qǐng)求，發(fā)送給API網(wǎng)關(guān)即可。
說明：無認(rèn)證方式下，API網(wǎng)關(guān)把請(qǐng)求內(nèi)容透?jìng)鹘o后端服務(wù)。因此，如果您希望在API后端服務(wù)進(jìn)行鑒權(quán)，可以使用“無認(rèn)證”方式，API調(diào)用方傳遞鑒權(quán)所需字段給后端服務(wù)，由后端服務(wù)進(jìn)行鑒權(quán)。 -
流量控制策略不生效怎么辦？
若流控策略的API流量限制或源IP流量限制不生效，檢查API是否綁定流控策略。
若流控策略的用戶流量限制不生效，檢查API的安全認(rèn)證方式是否為APP認(rèn)證或IAM認(rèn)證。
若流控策略的憑據(jù)流量限制不生效，檢查API的安全認(rèn)證方式是否為APP認(rèn)證。
-
怎樣給指定的用戶開放API？
可以采用以下兩種方式：
創(chuàng)建API時(shí)可選取APP認(rèn)證方式，APP key和APP Secret分享給指定的用戶。
使用訪問控制策略，按照IP地址或者帳號(hào)名，只允許符合允許策略的用戶調(diào)用API。
-
API發(fā)布到RELEASE環(huán)境可以正常訪問，發(fā)布到非RELEASE環(huán)境無法訪問？
添加x-stage請(qǐng)求消息頭后即可訪問。
例如：
r.Header.Add("x-stage", "RELEASE")
-
API導(dǎo)入失敗是什么原因？
可能原因1：?jiǎn)未螌?dǎo)入的API數(shù)量超出上限。當(dāng)前單次最高能導(dǎo)入300個(gè)API，如超出此數(shù)量，請(qǐng)分批導(dǎo)入，或提交配額修改工單，調(diào)整API單次導(dǎo)入上限。
可能原因2：參數(shù)錯(cuò)誤，需要檢查和修正。建議先在API網(wǎng)關(guān)控制臺(tái)界面創(chuàng)建一個(gè)API，將其導(dǎo)出作為API文件的模板。
可能原因3：YAML文件格式問題，需要檢查和修正。
可能原因4：本地proxy網(wǎng)絡(luò)限制，更換網(wǎng)絡(luò)環(huán)境。
可能原因5：定義API請(qǐng)求中，不允許在Header定義“X-Auth-Token”字段
-
怎樣保證API網(wǎng)關(guān)調(diào)用后端服務(wù)器的安全？
通過以下方法確保API網(wǎng)關(guān)調(diào)用后端服務(wù)器的安全：
為API綁定簽名密鑰。在綁定簽名密鑰后，API網(wǎng)關(guān)到后端服務(wù)的請(qǐng)求增加簽名信息，后端服務(wù)收到請(qǐng)求后計(jì)算簽名信息，驗(yàn)證計(jì)算后的簽名信息與API網(wǎng)關(guān)的簽名信息是否一致。
使用HTTPS對(duì)請(qǐng)求進(jìn)行加密。需要確保已有相應(yīng)的SSL證書。
使用后端認(rèn)證。您可以對(duì)后端服務(wù)開啟安全認(rèn)證，只受理攜帶正確授權(quán)信息的API請(qǐng)求。在創(chuàng)建API的定義后端服務(wù)階段，可以開啟后端認(rèn)證。