136 阿裏雲

API開放__使用手冊（開放API）_API 網關-阿裏雲

API創建完成後，您就可以開放API服務了。要開放API服務您需要綁定一個在阿裏雲係統備案成功的獨立域名，且該域名要完成CNAME解析。而獨立域名是綁定在API分組上麵的，所以在這個部分為您詳細說明一下開放API服務需要了解的API分組和域名。

API分組

API分組是API的管理單元。您創建API之前，需要先創建分組，然後在某個分組下創建API。分組包含名稱、描述、區域（Region）、域名幾大屬性。

分組的區域（Region）在分組創建時選定不可更改。創建API時，如果選定分組那麼Region也一同選定，不可更改。
每個賬號API分組個數上限為50個，每個分組API個數上限為200個。
域名。分組創建時，係統會為分組分配一個二級域名。如果需要開放API服務，您需要為分組綁定一個在阿裏雲係統備案成功的獨立域名，且將獨立域名CNAME到相應的二級域名上。每個分組最多隻能綁定5個獨立域名。具體請看下文——域名及證書。

環境管理

關於環境需要理解兩個概念，環境和環境變量。

環境是API分組上的一個配置，每個分組有若幹個環境。API錄入後，未經發布時，就隻是API定義。發布到某個環境後才是能夠對外提供服務的API。

環境變量是在環境上用戶可創建可管理的一種變量，該配置是固定於環境上的。如在線上環境創建變量，變量名為“Path”，變量值為“/stage/release”.

在API定義中的Path位置，協作“#Path#”，即配置為變量標識，變量名為Path。

那麼將該API發布到線上環境時，該API在線上環境的運行定義，Path處的“#Path#”，會取值為“/stage/release”。

而將該API發布到其他環境時，若環境上沒有環境變量#Path#，則無法取值，那麼API就無法調用。

使用環境變量可以解決後端服務需要區分環境的問題，通過不同的環境上配置不同的服務地址和Path，來調用不同的後端服務，同時API的定義配置又是一套。使用時需要注意以下幾點：

域名及證書

API網關通過域名來定位到一個唯一的API分組，再通過Path+HTTPMethod確定唯一的API。如果要開放API服務，您需要了解二級域名和獨立域名。

二級域名是分組創建時係統分配的，唯一且不可更改。在您還沒有獨立域名之前，您可以通過訪問二級域名來測試調用您的API。二級域名僅能用於測試，默認每天隻能請求1000次。
獨立域名即自定義域名，是您開放API服務需要綁定的，用戶通過訪問您的獨立域名來調用您開放的API服務。您可以為一個分組綁定多個獨立域名，上限為5個。對於獨立域名的配置您需要注意以下幾點：

a. 獨立域名不必須是根域名，可以是二級、三級域名

b. 獨立域名如果尚未備案，則可以在阿裏雲做首次備案

c. 獨立域名若已在其他係統備案，則需要在阿裏雲做備案接入

d. 獨立域名需要CNAME解析到分組的二級域名上

e. 滿足上述的備案和解析兩個要求，域名才能成功綁定
當您的API服務支持HTTPS協議時，需要為該域名上傳SSL證書，在“分組詳情”頁麵進行添加即可。SSL證書上傳不支持文件上傳，需要填寫證書名稱、內容和私鑰。

測試、線上、授權

通過上述操作您已經完成API的創建和域名綁定，接下來就可以將API發布到測試或者線上環境，進行調試和開放了。其中一個重要的環節是授權，授權即授予某個APP可以調用某個API的權限。

當您完成API創建之後，您就可以將API發布到測試或者線上，並給自己創建的APP授權，通過訪問二級域名來調用指定環境中的API，進行測試。
成功綁定獨立域名之後，您的API就可以正常投入使用或者開放了。您可以將API在市場上架，供客戶購買、調用。您還可以不經過購買將API授權給合作夥伴的APP。您的API就能夠被訪問了。

至此，您完成API服務的開放。在API創建到開放的整個過程中，您還可以隨時操作API的創建、修改、刪除、查看、測試、發布、下線、授權、解除授權、發布曆史及版本切換等操作。

最後更新：2016-11-24 11:23:48