全部產品
Search
文件中心

API Gateway:使用HTTPS並用網域名稱訪問

更新時間:Jul 26, 2024

使用者可以將自己的網域名稱綁定到API Gateway的API分組上,API Gateway通過網域名稱來定位到一個唯一的API分組,再通過Path+HTTPMethod確定唯一的API。

API Gateway為每個分組預設提供了公網次層網域,如果用戶端直接調用API分組提供的公網次層網域,將會受到每天1000次調用的限制(海外Region及中國香港限制100次/天)。您在正式生產環境開放API時,需要為API分組綁定獨立網域名稱才可正常使用,不受此項限制。

獨立網域名稱需要滿足以下幾點:

  • 中國內地Region的獨立網域名稱需要在阿里雲備案或者將備案接入阿里雲。

  • 獨立網域名稱要CNAME解析到該分組的次層網域上,然後操作綁定。

  • 獨立網域名稱在API Gateway上沒有被別的使用者綁定過,否則綁定操作需要走驗證流程,才能成功綁定。若該分組下的API需要支援HTTPS協議,您還需要為該獨立網域名稱匯入或者上傳SSL認證。

1. 綁定網域名稱步驟

使用者將自己的網域名稱綁定到API Gateway需要以下兩步操作:

  • 在API Gateway控制台將網域名稱綁定到API分組上;

  • 將自己的網域名稱通過CNAME方式解析到API Gateway提供的次層網域上,進行業務流量切換。

1.1 綁定網域名稱

1.進入API Gateway控制台,點擊左側導覽列的API管理>分組管理,進入分組列表頁面,然後選擇要綁定網域名稱的分組,進入分組詳情頁面。

2.在頁面右下方看到綁定網域名稱的按鈕,點擊按鈕:

3.進入網域名稱綁定頁面,填寫您自己的網域名稱,點擊確定後網域名稱綁定成功。

1.1 CNAME綁定網域名稱

將自己的網域名稱通過CNAME方式解析到API Gateway提供的次層網域上的具體步驟如下:

1.在分組詳情頁面找到這個分組對應的API Gateway提供的公網次層網域。

2.進入自己的網域名稱解析管理頁面,阿里雲的網域名稱解析管理頁面入口在:https://dns.console.aliyun.com,在網域名稱列表頁面找到要管理的網域名稱,點擊網域名稱上的連結進入網域名稱的管理頁面。

3.增加或者修改一條需要綁定到API Gateway的網域名稱的子記錄。

4.在綁定頁面,選定CNAME類型,輸入本節第二步在API Gateway找到的公網次層網域。

5.點擊確認後,CNAME綁定網域名稱的工作就完成了,我們可以在網域名稱解析記錄頁面看到剛才綁定的次層網域。

2. 上傳網域名稱SSL認證步驟

綁定好網域名稱後,就可以使用綁定的網域名稱以HTTP方式訪問分組下的所有API了,但是如果想以HTTPS的方式訪問分組下的API,需要將您的網域名稱認證上傳到剛才綁定的網域名稱下才行。API Gateway提供兩種網域名稱綁定方式,自動從阿里雲認證服務匯入認證和手動上傳您在其他認證服務提供者擷取到的認證。

2.1 產生網域名稱SSL認證

下面我們簡單介紹下在阿里雲的認證服務產生一個個人測試認證(免費版)的流程:

1.進入阿里雲認證服務控制台

2.在認證購買頁面完成認證的購買與網域名稱的綁定,請參考認證的SSL認證快速上手。認證申請完成後,回到API Gateway控制台對應分組的分組詳情頁面。

2.2 匯入或上傳網域名稱SSL認證

購買好認證或者準備好認證檔案後,就可以在API Gateway控制台將認證匯入或者上傳到API Gateway的分組的綁定的網域名稱下了,下面是認證匯入和上傳流程。

2.2.1 匯入認證

如果您是在阿里雲的Apsara Stack Security認證服務中購買了認證,可以直接將認證匯入到API Gateway的分組網域名稱下:

1.進入API Gateway分組詳情頁面,可以在頁面下方看到所有綁定好網域名稱列表,可以選擇我們需要匯入的認證對應的網域名稱一欄,點擊“選擇認證”連結。

2.在“選擇認證”子頁面,點擊“尋找認證”按鈕,等所有屬於您的認證查詢出來後,選擇一個對應的網域名稱認證,點擊“同步認證”按鈕,完成認證的同步。

2.2.2 上傳認證

如果您的認證不是在阿里雲購買的,也可以將您的網域名稱認證上傳到API Gateway。具體流程如下:

1.進入API Gateway分組詳情頁面,可以在頁面下方看到所有綁定好網域名稱列表,可以選擇我們需要匯入的認證對應的網域名稱一欄,點擊“選擇認證”連結;

2.在“選擇認證”子頁面,點擊“手動上傳認證”按鈕;

3.進入手動上傳認證頁面後,按照頁面提示填寫認證內容;

4.上傳認證成功後,可以在網域名稱列表欄看到網域名稱後“選擇認證”連結變成了“更新認證”;認證上傳成功後,就可以使用HTTPS協議訪問對應的網域名稱了。