全部產品
Search
文件中心

API Gateway:支援 HTTPS

更新時間:Oct 11, 2024

HTTPS在HTTP的基礎上加入了SSL協議,對資訊、資料加密,用來保證資料轉送的安全。現如今被廣泛使用。

API Gateway支援使用HTTPS對您的API請求進行加密。可以控制到API層級,您可以強制您的API只支援HTTP、HTTPS或者兩者均支援。如果您的API需要支援HTTPS,操作流程如下:

步驟1:準備

您需要準備如下材料:

  • 一個自有可控網域名稱。

  • 為這個網域名稱申請一個SSL認證

  • 自訂上傳認證,包含認證/私密金鑰,均為 PEM 格式(註:API GatewayTengine服務是基於Nginx,因此只支援Nginx能讀取的認證,即PEM格式)。

SSL認證會包含兩部分內容:XXXXX.key、XXXXX.pem,可以使用文字編輯器開啟。樣本如下:

KEY:

-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
....
-----END RSA PRIVATE KEY-----

PEM:

-----BEGIN CERTIFICATE-----
MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
...
-----END CERTIFICATE-----	

步驟2:綁定SSL認證

登入API Gateway控制台,在左側導覽列選擇API 管理 > 分組管理,單擊您需要綁定SSL認證的分組,查看分組詳情。在綁定SSL認證之前,您首先需要在API分組上綁定獨立網域名稱

獨立網域名稱處添加SSL認證。

  • 認證名稱:使用者自訂名稱,以供後續識別。

  • 認證內容:認證的完整內容,需要複製XXXXX.pem中的全部內容。

  • 私密金鑰:認證的私密金鑰,需要複製XXXXX.key中的內容。點擊確定後,完成SSL認證的綁定。

步驟3:API配置調整

綁定SSL認證後,您可以按API控制不同的訪問方式,支援HTTP、HTTPS、HTTP和HTTPS三種,出於安全考慮,建議全部配置成HTTPS。

  1. API Gateway控制台的左側導覽列選擇API 管理 > API列表找到相應API。

  2. 單擊目標API名稱,在右上方單擊編輯

  3. 進入基本資料,單擊下一步,進入定義API請求欄,勾選協議

    image

API支援的協議包括:

  • HTTP:只允許HTTP訪問,不允許HTTPS。

  • HTTPS:只允許HTTPS訪問,不允許HTTP。

  • HTTP和HTTPS:兩者均可,調整後,API支援HTTPS協議配置完成。您的API將支援HTTPS訪問。