API網(wǎng)關(guān)
API網(wǎng)關(guān)基本概念
API
API(Application Programming Interface,應(yīng)用程序編程接口)是一些預先定義的函數(shù),應(yīng)用將自身的服務(wù)能力封裝成API,并通過API網(wǎng)關(guān)開放給用戶調(diào)用。
API包括基本信息、前后端的請求路徑和參數(shù)以及請求相關(guān)協(xié)議。
API分組
API分組是同一種業(yè)務(wù)API的集合,API開發(fā)者以API分組為單位,管理分組內(nèi)的所有API。
環(huán)境
為了方便管理API的生命周期,API網(wǎng)關(guān)定義了API受限使用范圍,這個受限使用的范圍,稱為環(huán)境,例如API的測試環(huán)境,開發(fā)環(huán)境等。
環(huán)境定義了API生命周期管理過程中的不同狀態(tài),API可以被發(fā)布到不同的自定義環(huán)境中。
調(diào)用不同環(huán)境的API,一般通過在API調(diào)用的請求頭增加指定的頭部參數(shù),頭部參數(shù)名固定為x-stage,它的取值叫環(huán)境名,用以區(qū)分不同的環(huán)境。
環(huán)境變量
在環(huán)境上創(chuàng)建可管理的一種變量,該變量固定在環(huán)境上。通過創(chuàng)建環(huán)境變量,實現(xiàn)同一個API,在不同環(huán)境中調(diào)用不同的后端服務(wù)。
流量控制
流量控制支持從用戶、應(yīng)用(憑據(jù))、源IP和時間段等不同的維度限制對API的調(diào)用次數(shù),保護后端服務(wù)。
API網(wǎng)關(guān)支持按分/按秒粒度級別的流量控制。
訪問控制
訪問控制策略是API網(wǎng)關(guān)提供的API安全防護組件之一,主要用來控制訪問API的IP地址和帳戶,您可以通過設(shè)置IP地址或帳戶的黑白名單來允許/拒絕某個IP地址或帳戶訪問API。
應(yīng)用(憑據(jù))
應(yīng)用(APP)定義了一個API調(diào)用者的身份??梢詫⒁粋€API授權(quán)給多個應(yīng)用,也可以將多個API授權(quán)給同一個應(yīng)用。
簽名密鑰
簽名密鑰由一對Key和Secret組成,用于后端服務(wù)驗證API網(wǎng)關(guān)的身份,在API網(wǎng)關(guān)請求后端服務(wù)時,保障后端服務(wù)的安全。
當簽名密鑰綁定API后,API網(wǎng)關(guān)向后端服務(wù)發(fā)送此API的請求時,會增加相應(yīng)的簽名信息,此時后端服務(wù)依照同樣方式進行簽名并得到簽名結(jié)果,如果和API網(wǎng)關(guān)傳過來的Authorization頭中簽名一致,則可證明API請求確實來自API網(wǎng)關(guān),而不是其他偽造請求。
VPC通道(負載通道)
API網(wǎng)關(guān)通過VPC通道訪問部署在VPC內(nèi)的服務(wù),您可以借助API網(wǎng)關(guān)將部署在VPC中的后端服務(wù)開放給第三方用戶調(diào)用。
自定義認證
自定義認證指在API調(diào)用過程中,用戶可自行定義認證規(guī)則,實現(xiàn)API網(wǎng)關(guān)對調(diào)用方發(fā)起的請求、后端服務(wù)對API網(wǎng)關(guān)轉(zhuǎn)發(fā)的請求進行有效性以及完整性校驗。
自定義認證包含以下兩種認證:
前端自定義認證:如果您希望使用自己的認證系統(tǒng),而不是APP認證/華為IAM認證對API的訪問進行認證鑒權(quán)時,您可以使用自定義認證,通過您自定義的函數(shù)進行認證鑒權(quán)。
后端自定義認證:當不同的后端服務(wù)使用不同的認證系統(tǒng)時,導致您需要為不同的認證系統(tǒng)定制化開發(fā)API,而APIG通過自定義認證功能,將多種認證系統(tǒng)集成,簡化API開發(fā)的復雜度。您只需要在APIG中創(chuàng)建自定義的函數(shù)認證,APIG通過此函數(shù)對接后端認證系統(tǒng),獲取后端服務(wù)的訪問授權(quán)。
簡易認證
簡易認證指調(diào)用API時,在HTTP請求頭部消息增加一個參數(shù)X-Apig-AppCode(參數(shù)值填AppCode),而不需要對請求內(nèi)容簽名,API網(wǎng)關(guān)也僅校驗AppCode,不校驗請求簽名,從而實現(xiàn)快速響應(yīng)。
網(wǎng)關(guān)響應(yīng)
網(wǎng)關(guān)響應(yīng)指API網(wǎng)關(guān)未能成功處理API請求,從而產(chǎn)生的錯誤響應(yīng)。API網(wǎng)關(guān)提供默認的網(wǎng)關(guān)響應(yīng)(default),如果您需要自定義響應(yīng)狀態(tài)碼或網(wǎng)關(guān)響應(yīng)內(nèi)容,可在API分組管理中新增網(wǎng)關(guān)響應(yīng),其中響應(yīng)內(nèi)容符合JSON格式即可。
API網(wǎng)關(guān)常見問題
API網(wǎng)關(guān)常見問題
API網(wǎng)關(guān)相關(guān)視頻
API網(wǎng)關(guān)
05:43
API網(wǎng)關(guān)
02:11
API網(wǎng)關(guān)精選推薦
1對1咨詢專屬顧問
華為云咨詢電話:950808或4000-955-988 轉(zhuǎn)1
華為云咨詢電話:950808或4000-955-988 轉(zhuǎn)1