文件Journey OptimizerJourney Optimizer 指南

使用上限API work

Last update: Thu May 22 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：
  • API

建立對象：

  • 初學者
  • 使用者

上限API可幫助您建立、設定和監控您的上限設定。

本節提供如何使用API的全域資訊。 Adobe Journey Optimizer API檔案中提供詳細的API描述。

設定API說明與Postman集合的上限 description

下表列出適用於上限API的可用命令。 Adobe Journey Optimizer API檔案提供詳細資訊，包括要求範例、引數和回應格式。

方法
路徑
說明
POST
list/endpointConfig
取得端點上限設定清單
POST
/endpointConfigs
建立端點上限設定
POST
/endpointConfigs/{uid}/deploy
部署端點上限設定
POST
/endpointConfigs/{uid}/undeploy
取消部署端點上限設定
POST
/endpointConfigs/{uid}/canDeploy
檢查是否可以部署端點上限設定
PUT
/endpointConfigs/{uid}
更新端點上限設定
GET
/endpointConfigs/{uid}
擷取端點上限設定
DELETE
/endpointConfigs/{uid}
刪除端點上限設定

建立或更新設定時，會自動執行檢查以確保語法和裝載的完整性。
如果發生某些問題，作業會傳回警告或錯誤，以協助您更正設定。

此外，這裡也提供Postman集合，協助您進行測試設定。

此集合已設定為共用透過​ Postman Console的整合功能產生的Adobe I/O變數集合 >嘗試使用>下載Postman，這會產生具有所選整合值的Postman環境檔案。

一旦下載並上傳至 Postman，您需要新增三個變數：{JO_HOST}、{BASE_PATH}以及{SANDBOX_NAME}。

  • {JO_HOST} ： Journey Optimizer閘道URL。
  • {BASE_PATH} ： API的進入點。
  • {SANDBOX_NAME}：標題 x-sandbox-name (例如，'prod')，此名稱對應於將進行 API 操作的沙箱名稱。如需詳細資訊，請參閱沙箱概觀。

端點設定

以下是端點設定的基本結構：

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource"
            "maxHttpConnections": <max connections count to the endpoint (optional)>
            "rating": {
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}
IMPORTANT
maxHttpConnections ​引數是選用的。 它可讓您限制Journey Optimizer將開啟給外部系統的連線數量。
可設定的最大值為400。 如果未指定任何專案，則系統可能會開啟數千個連線，視系統的動態縮放而定。
在部署上限設定時，如果未提供「maxHttpConnection」值，則會在部署的設定中新增預設的「maxHttpConnection = -1」，這表示Journey Optimizer將使用預設系統值。

範例：

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  }
}
IMPORTANT
只有在呼叫​ 部署 ​端點之後，設定才會啟用。

警告和錯誤

呼叫​ canDeploy ​方法時，程式會驗證設定並傳回由其唯一識別碼識別的驗證狀態：

"ok" or "error"

可能的錯誤包括：

  • ERR_ENDPOINTCONFIG_100：設定上限：遺漏或無效的url
  • ERR_ENDPOINTCONFIG_101：上限設定：格式錯誤的url
  • ERR_ENDPOINTCONFIG_102：上限設定：格式錯誤的url：不允許在host：port中使用url中的wildchar
  • ERR_ENDPOINTCONFIG_103：上限設定：遺失HTTP方法
  • ERR_ENDPOINTCONFIG_104：上限設定：未定義任何通話分級
  • ERR_ENDPOINTCONFIG_107：上限設定：無效的最大呼叫計數(maxCallsCount)
  • ERR_ENDPOINTCONFIG_108：上限設定：無效的最大呼叫計數(periodInMs)
  • ERR_ENDPOINTCONFIG_111：上限設定：無法建立端點設定：無效的承載
  • ERR_ENDPOINTCONFIG_112：上限設定：無法建立端點設定：需要JSON裝載
  • ERR_AUTHORING_ENDPOINTCONFIG_1：無效的服務名稱<!--<given value>-->：必須為'dataSource'或'action'

可能的警告為：

ERR_ENDPOINTCONFIG_106：上限設定：未定義最大HTTP連線：預設無限制

使用案例

本節列出在Journey Optimizer中管理上限設定的主要使用案例，以及實施使用案例所需的相關API命令。

每個API命令的詳細資訊可在API說明和Postman集合中取得。

建立和部署新的上限設定

要使用的API呼叫：

  1. list — 擷取現有設定。
  2. create — 建立新的組態。
  3. candeploy — 檢查組態是否可以部署。
  4. deploy — 部署設定。
更新並部署上限設定（尚未部署）

要使用的API呼叫：

  1. list — 擷取現有設定。
  2. get — 擷取特定設定的詳細資料。
  3. update — 修改設定。
  4. candeploy — 檢查部署資格。
  5. deploy — 部署設定。
取消部署和刪除已部署的上限設定

要使用的API呼叫：

  1. list — 擷取現有設定。
  2. undeploy — 取消部署設定。
  3. delete — 移除設定。
在一個步驟中刪除已部署的上限設定

您只能在一個API呼叫中使用forceDelete引數來取消部署及刪除組態。

要使用的API呼叫：

  1. list — 擷取現有設定。
  2. delete（含forceDelete引數） — 在單一步驟中強制刪除已部署的組態。
更新已部署的上限設定
note note
NOTE
更新已部署的組態後需要重新部署。

要使用的API呼叫：

  1. list — 擷取現有設定。
  2. get — 擷取特定設定的詳細資料。
  3. update — 修改設定。
  4. undeploy — 在套用變更之前先取消部署設定。
  5. candeploy — 檢查部署資格。
  6. deploy — 部署更新的設定。
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76