閱讀307 返回首頁    go 財經資訊


API管理__使用手冊(開放API)_API 網關-阿裏雲

API定義就是指您創建API時對API的請求結構的各方麵定義。您可以在控製台完成API定義的查看、編輯、刪除、創建、複製。您需要注意以下幾點:

  1. 當您需要編輯某個API的定義時,如果該API已經發布,對定義的修改不會對線上產生影響,定義修改後需要再次發布才能把修改後的定義同步到線上環境。
  2. 當您想要刪除某個API,如果該API已經發布,則不允許直接刪除API定義,需要先將API下線,然後刪除。
  3. 我們還為您提供了複製定義的功能。您可以從測試環境/線上環境複製線上的定義覆蓋當前的最新定義,然後重新點擊編輯進行修改。

API發布管理

當您完成API的創建後,您可以將API發布到測試或者線上。也可以將測試或者線上的API下線。您需要注意以下幾點:

  1. API創建完成後,發布到某環境,通過二級域名或者獨立域名訪問時,需要在請求的Header指定要請求的環境,參見《請求示例
  2. 當您要發布某個API時,如果該API在測試或者線上已經有版本在運行,您的此次發布將使測試或者線上的該API被覆蓋,實時生效。但是曆史版本及定義會有記錄,您可以快速回滾。
  3. 您可以將測試或者線上的某個API下線,下線之後,與策略、密鑰、APP的綁定或者授權關係依然存在,再次上線時會自動生效。如果要解除關係,需要專門操作刪除。

API授權管理

您的API如果上架到市場,那麼購買者有權利操作給自己的某個APP授權。

如果不經過購買行為,您需要在線下跟合作夥伴建立使用關係,那麼您需要通過授權來建立API和APP的權限關係。您將API發布到線上環境後,需要給客戶的APP授權,客戶才能用該APP進行調用。您有權對此類授權操作建立或者解除某個API與某個APP的授權關係,API網關會對權限關係進行驗證。操作授權時,您需要注意以下幾點:

  1. 您可以將一個或者多個API授權給一個或者多個APP。批量操作時,建議不要同時操作多個分組下的API。
  2. 批量操作時,先選擇API後選擇環境。比如一個API在測試和線上均有發布,最後選擇了測試,就隻會將測試下的該API授權。
  3. 您可以通過客戶提供給您的AppID或者阿裏雲郵箱賬號來定位APP。
  4. 當您需要解除某個API下某個APP的授權時,您可以查看API的授權列表,在列表頁進行解除。

曆史與版本切換

您可以查看您每個API的發布曆史記錄,包括每次發布的版本號、說明、環境、時間和具體定義內容。

查看曆史時,您可以選定某個版本然後操作切換到此版本,該操作會使該版本直接在指定環境中替換之前的版本,實時生效。

最後更新:2016-11-23 16:04:04

  上一篇:go API開放__使用手冊(開放API)_API 網關-阿裏雲
  下一篇:go 簽名密鑰__使用手冊(開放API)_API 網關-阿裏雲