上限API可幫助您建立、設定和監控您的上限設定。
本節提供如何使用API的全域資訊。 詳細的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} |
刪除端點上限設定 |
建立或更新設定時,會自動執行檢查以確保語法和裝載的完整性。
如果發生某些問題,作業會傳回警告或錯誤,以協助您更正設定。
以下是端點設定的基本結構:
{
"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>
"rating": {
"maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
"periodInMs": <integer value greater than 0>
}
},
...
}
}
`{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"maxHttpConnections": 30000,
"rating": {
"maxCallsCount": 5000,
"periodInMs": 1000
}
}
},
"orgId": "<IMS Org Id>"
}
當 canDeploy 方法呼叫,該程式會驗證設定並傳回由其唯一ID識別的驗證狀態,其形式為:
"ok" or "error"
可能的錯誤包括:
<!--<given value>-->
:必須為「dataSource」或「action」可能的警告是:
ERR_ENDPOINTCONFIG_106:上限設定:未定義最大HTTP連線:預設無限制
在本節中,您將找到五個主要使用案例,您可以執行這些案例來管理您的上限設定,位置在 Journey Optimizer.
為協助您進行測試和設定,可在此處取得 Postman 集合。
此 Postman 集合已設定為共用透過 Adobe I/O 主控台的整合產生的 Postman 變數集合 > 試用 > 下載 Postman,會產生包含選取整合值的 Postman 環境檔案。
一旦下載並上傳至 Postman,您需要新增三個變數:{JO_HOST}
、{BASE_PATH}
以及{SANDBOX_NAME}
。
{JO_HOST}
: Journey Optimizer閘道 URL{BASE_PATH}
:API 的進入點。{SANDBOX_NAME}
:標題 x-sandbox-name (例如,'prod'),此名稱對應於將進行 API 操作的沙箱名稱。如需詳細資訊,請參閱沙箱概觀。您將在下節找到用於執行使用案例的 Rest API 呼叫排序清單。
使用案例n°1: 建立及部署新的上限設定
使用案例n°2: 更新和部署尚未部署的上限設定
使用案例n°3: 取消部署和刪除已部署的上限設定
使用案例n°4: 刪除已部署的上限設定。
在僅一個 API 呼叫,您可以使用 forceDelete 參數來取消部署和刪除設定。
使用案例n°5: 更新已部署的上限設定