使用上限API

最近更新： 2025年4月1日

创建对象：

  • 初学者
  • 用户

上限API可帮助您创建、配置和监控上限配置。

本节提供有关如何使用API的全球信息。 Adobe Journey Optimizer API文档中提供了详细的API描述。

API描述和Postman收藏集上限

下表列出了用于上限API的可用命令。 Adobe Journey Optimizer API文档中提供了请求示例、参数和响应格式的详细信息。

方法路径描述
POSTlist/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控制台的集成 >尝试使用>下载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
      }
    }
  }
}