歡迎使用阿里雲API Gateway服務。使用者可以使用本文檔介紹的API對API Gateway服務進行相關操作。
請確保在使用這些介面前,已充分瞭解了API Gateway產品說明、使用協議和收費方式。
術語表
術語 | 全稱 | 中文 | 說明 |
|---|---|---|---|
Region | 地區 | 使用者開放API,需選擇API在API Gateway的部署地區,建議選擇與後端服務相同的Region。 | |
API | API | 使用者開放API,在API Gateway錄入API,以提供介面的方式對外提供服務或者資料。 | |
Group | API Group | API分組 | 一組API。
|
SubDomain | 分組次層網域 | 使用者開放API,建立的每個API分組都有一個次層網域,獨立網域名稱需要解析到該次層網域上,直接存取該網域名稱可以調用測試環境的API。 | |
CustomDomain | Custom Domain | 網域名稱 | 使用者開放API,需要綁定自己的獨立網域名稱,該網域名稱需要CNAME解析到分組次層網域上且在阿里雲備案或備案接入。且若支援HTTPS協議,還需為網域名稱上傳SSL合規認證。 |
Stage | 環境 | 使用者開放API,建立的每個API分組目前有兩個環境,測試和線上。使用者操作API發布到某個環境後,API才能被調用。區別在於,直接存取分組次層網域調用API,預設是調用測試環境。 | |
Signature | Backend Signature | 後端簽名密鑰 | 用於開放API的使用者給API Gateway頒發身分識別驗證密鑰。後端簽名密鑰綁定到API後對綁定的API即時生效。網關接收到這些API的請求,再去請求後端服務的時候就會帶上籤名資訊,供後端服務對API Gateway做身份校正。 |
TrafficControl | 流量控制策略(簡稱“流控策略”) | 用於開放API的使用者對API做訪問流控。流控策略與API綁定後對綁定的API即時生效。流控策略可以從Api、App、User三個維度管控API的調用。流控策略下還可以配置特殊流控,如某App/User在調用綁定的API時,可以按照特殊的值來流控。 | |
Special | Special Traffic Control | 特殊流量控制(簡稱“特殊流控”) | 是流控策略的一個配置,可以指定某App/User,針對流控策略綁定的API,按照單獨的值進行流控。 |
APP | 應用 | 調用其他使用者開放的API時,需要建立一個APP作為調用者的身份。請求到達網關時,會對AppKey和AppSecret進行簽名校正。 |
業務限制資源規格限制說明
在API Gateway中,對每個使用者可建立的API分組、API個數都有限制,對使用者經過API Gateway調用開放的API也有限制。詳情請參考官網文檔對使用限制的說明 使用限制。
在介面說明部分,凡出現與官網上給出的限制發生矛盾時,均以官網的限制說明為準。