設定開發人員入口網站網址

私有雲的邊緣 4.17.05 版

Apigee 提供開發人員服務入口網站,可用於建構及發布自訂網站,為您的開發社群提供上述所有服務。Edge 客戶可以在雲端或地端部署環境中建立自己的開發人員入口網站。詳情請參閱「什麼是開發人員入口網站?」一文。

Edge UI 會在「Publish」(發布) >「Developer」(開發人員)DevPortal 頁面顯示「DevPortal」DevPortal按鈕,只要按一下這個按鈕,即可開啟與機構相關聯的入口網站。根據預設,該按鈕會開啟下列網址:

http://live-{orgname).devportal.apigee.com

{orgname} 是機構名稱。

你可以將這個網址設為其他網址 (例如入口網站有 DNS 記錄,或是完全停用這個按鈕)。請使用下列機構屬性來控管按鈕:

  • features.devportalDisabled:設為 false (預設) 即可啟用按鈕;設為 true 即可停用該按鈕。
  • features.devportalUrl:設為開發人員入口網站的網址。

您可分別為每個機構設定這些屬性。如要設定這些屬性,請先使用下列 API 呼叫來判斷機構目前的資源設定:

curl -H "Content-Type:application/json" \
-u adminEmail:pword -X GET \
http://<ms-IP>:8080/v1/organizations/{orgname}

這個呼叫會傳回以下列格式描述機構的物件:

{
  "createdAt" : 1428676711119,
  "createdBy" : "me@my.com",
  "displayName" : "orgname",
  "environments" : [ "prod" ],
  "lastModifiedAt" : 1428692717222,
  "lastModifiedBy" : "me@my.com",
  "name" : "organme",
  "properties" : {
    "property" : [{
      "name" : "foo",
      "value" : "bar"}]
  },
  "type" : "paid"
}

請注意物件 properties 區域中的任何現有屬性。為機構設定屬性之後,屬性中的值會覆寫所有目前的屬性。 因此,如要在機構中設定 features.devportalDisabledfeatures.devportalUrl,請務必在設定現有屬性時複製所有屬性。

使用下列 PUT 呼叫來設定機構的屬性:

curl -H "Content-Type:application/json" \
-u adminEmail:pword -X PUT \
http://<ms-IP>:8080/v1/organizations/{orgname} \
-d '{
  "displayName" : "orgname",
  "name" : "orgname",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"},
    {
      "name": "features.devportalUrl",
      "value": "http://dev-orgname.devportal.apigee.com/"},
    {
      "name": "features.devportalDisabled",
      "value": "false"}]
  }
}'

在 PUT 呼叫中,您只需要指定 displayNamenameproperties。請注意,這個呼叫包含最初在機構設定的「foo」屬性。