API網(wǎng)關(guān)策略
API網(wǎng)關(guān)通過策略的方式，為API提供靈活的控制策略和擴(kuò)展能力。
-
收起
API網(wǎng)關(guān)策略限制 收起
一個API只能綁定一個相同類型的策略。
策略和API本身相互獨(dú)立，只有為API綁定策略后，策略才對API生效。為API綁定策略時需指定發(fā)布環(huán)境，策略只對指定環(huán)境上的API生效。
策略的綁定、解綁、更新會實時生效，不需要重新發(fā)布API。
API的下線操作不影響策略的綁定關(guān)系，再次發(fā)布后仍然會帶有下線前綁定的策略。
如果策略與API有綁定關(guān)系，則策略無法執(zhí)行刪除操作。
策略參數(shù)會明文展示，為防止信息泄露，請謹(jǐn)慎配置。
-
收起
API網(wǎng)關(guān)策略類型 收起
API網(wǎng)關(guān)傳統(tǒng)策略
流量控制策略
流量控制支持從用戶、憑據(jù)和時間段等不同的維度限制對API的調(diào)用次數(shù)，保護(hù)后端服務(wù)。支持按分/按秒粒度級別的流量控制。為了提供持續(xù)穩(wěn)定的服務(wù)，您可以通過創(chuàng)建流控策略，針對部分API進(jìn)行流量控制。
使用限制
API添加流控策略相當(dāng)于流控策略同步綁定了API。同一個環(huán)境中，一個API只能被一個流控策略綁定，但一個流控策略可以綁定多個API。
如果API未綁定流控策略，流控限制值為實例“配置參數(shù)”中“ratelimit_api_limits”的參數(shù)運(yùn)行值。
訪問控制策略
訪問控制策略是API網(wǎng)關(guān)提供的API安全防護(hù)組件之一，主要用來控制訪問API的IP地址和帳戶，您可以通過設(shè)置IP地址或帳戶的黑白名單來禁止/允許某個IP地址/帳號名/帳號ID訪問API。
訪問控制策略和API本身是相互獨(dú)立的，只有將訪問控制策略綁定API后，訪問控制策略才對綁定的API生效。
使用限制
同一個API在同一個環(huán)境中只能綁定一個相同限制類型的訪問控制策略，一個訪問控制策略可以綁定多個API。
2022年12月31日后創(chuàng)建的專享版實例支持限制調(diào)用API的帳號ID，在這之前創(chuàng)建的專享版實例不支持，如需使用，請聯(lián)系客服。
簽名秘鑰策略
簽名密鑰用于后端服務(wù)驗證API網(wǎng)關(guān)的身份，在API網(wǎng)關(guān)請求后端服務(wù)時，保障后端服務(wù)的安全。
簽名密鑰由一對Key和Secret組成，簽名密鑰需要綁定到API才能生效。當(dāng)簽名密鑰綁定API后，API網(wǎng)關(guān)向后端服務(wù)發(fā)送此API的請求時，會增加相應(yīng)的簽名信息，此時需要后端服務(wù)依照同樣方式進(jìn)行簽名，通過比對簽名結(jié)果和API網(wǎng)關(guān)傳過來的Authorization頭中簽名是否一致來校驗API的合法性。
使用限制
同一個環(huán)境中一個API只能被一個簽名密鑰綁定，一個簽名密鑰可以綁定多個API。
API網(wǎng)關(guān)插件策略
跨域資源共享策略
出于安全性考慮，瀏覽器會限制從頁面腳本內(nèi)發(fā)起的跨域請求，此時頁面只能訪問當(dāng)前域的資源。CORS允許瀏覽器向跨域服務(wù)器發(fā)送XMLHttpRequest請求，從而實現(xiàn)跨域訪問。更多跨域訪問的說明請參見訪問控制策略說明。
跨域資源共享策略為跨域訪問提供指定預(yù)檢請求頭和響應(yīng)頭、自動創(chuàng)建跨域預(yù)檢請求API的擴(kuò)展能力，可快速、靈活的實現(xiàn)API的跨域訪問。
使用限制
同一API分組下，相同請求路徑的所有API，只能綁定同一個跨域資源共享策略。
如果API開啟了“支持CORS”功能的同時，也綁定了跨域資源共享策略，則以綁定的策略為準(zhǔn)。
如果某個請求路徑下有OPTIONS方法的API，則該請求路徑下的所有API均不允許綁定跨域資源共享策略。
為API綁定策略時，API的請求方法必須為allow_methods中允許的請求方法。
流量控制2.0策略
流量控制2.0策略可以限制單位時間內(nèi)API的被調(diào)用次數(shù)，支持參數(shù)流控、基礎(chǔ)流控和基于基礎(chǔ)流控的特殊流控。
基礎(chǔ)流控
可以對API、用戶、憑據(jù)、源IP進(jìn)行多維度流控，與已有的流量控制策略說明功能一致但不兼容。
參數(shù)流控
支持根據(jù)Header、Path、Method、Query以及系統(tǒng)變量中的參數(shù)值進(jìn)行自定義流控。
基于基礎(chǔ)流控的特殊流控
對某個憑據(jù)或租戶進(jìn)行特定的流控。
使用限制
如果一個API綁定流量控制后，繼續(xù)綁定參數(shù)控制策略，流量控制會失效。
參數(shù)流控的規(guī)則最多可定義100個。
策略內(nèi)容最大長度65535。
斷路器策略
斷路器是API網(wǎng)關(guān)在后端服務(wù)出現(xiàn)性能問題時保護(hù)系統(tǒng)的內(nèi)置機(jī)制。當(dāng)API的后端服務(wù)出現(xiàn)連續(xù)N次超時或者時延較高的情況下，會觸發(fā)斷路器的降級機(jī)制，向API調(diào)用方返回固定錯誤或者將請求轉(zhuǎn)發(fā)到指定的降級后端。當(dāng)后端服務(wù)恢復(fù)正常后，斷路器關(guān)閉，請求恢復(fù)正常。
HTTP響應(yīng)頭管理策略
API響應(yīng)是指API網(wǎng)關(guān)返回客戶端的響應(yīng)，HTTP響應(yīng)頭是API響應(yīng)中的一部分。您可以自定義HTTP響應(yīng)頭，在返回的API響應(yīng)中指定您配置的響應(yīng)頭。
使用限制
無法修改API網(wǎng)關(guān)增加的系統(tǒng)響應(yīng)頭（x-apig-*，x-request-id等），包括API網(wǎng)關(guān)提供的CORS功能增加的響應(yīng)頭。
Kafka日志推送策略
支持收集已開放API的調(diào)用日志信息。Kafka日志推送策略提供了把API的詳細(xì)調(diào)用日志推送到Kafka的能力，方便用戶獲取API的調(diào)用日志信息。
使用限制
同一個APIG實例內(nèi)最多可創(chuàng)建5個Kafka日志推送策略。
API綁定Kafka日志推送策略后，性能將損耗30%。