使用上限API work
上限API可帮助您创建、配置和监控上限配置。
本节提供有关如何使用API的全球信息。 Adobe Journey Optimizer API文档中提供了详细的API描述。
API描述和Postman收藏集上限 description
下表列出了用于上限API的可用命令。 Adobe Journey Optimizer API文档中提供了请求示例、参数和响应格式的详细信息。
{uid}/deploy{uid}/undeploy{uid}/canDeploy{uid}{uid}{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>
}
},
...
}
}
maxHttpConnections值，则会在部署的配置中添加默认maxHttpConnections = -1，并且Journey Optimizer会使用默认的系统值。示例：
{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"rating": {
"maxCallsCount": 500,
"periodInMs": 1000
}
}
}
}
警告和错误
调用 canDeploy 方法时，进程将验证配置并返回由其唯一ID标识的验证状态：
"ok" or "error"
潜在的错误包括：
- ERR_ENDPOINTCONFIG_100：配置上限：缺少URL或无效的URL
- ERR_ENDPOINTCONFIG_101：上限配置：错误的url
- ERR_ENDPOINTCONFIG_102：上限配置：格式错误的url：主机:port中不允许使用url中的通配符
- ERR_ENDPOINTCONFIG_103：上限配置：缺少HTTP方法
- ERR_ENDPOINTCONFIG_104：上限配置：未定义调用等级
- ERR_ENDPOINTCONFIG_107：上限配置：无效的最大调用计数(maxCallsCount)
- ERR_ENDPOINTCONFIG_108: capping config: invalid max calls count (periodInMs)
- ERR_ENDPOINTCONFIG_111: capping config: can’t create endpoint config: invalid payload
- ERR_ENDPOINTCONFIG_112: capping config: can’t create endpoint config: expecting a JSON payload
- ERR_AUTHORING_ENDPOINTCONFIG_1: invalid service name
<!--<given value>-->: must be ‘dataSource’ or ‘action’
The potential warning is:
ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default
用例
This section lists key use cases for managing capping configurations in Journey Optimizer and the associated API commands required to implement the use case.
有关每个API命令的详细信息，请参见API描述和Postman集合。
要使用的API调用：
list— 检索现有配置。create— 创建新配置。candeploy— 检查配置是否可以部署。deploy— 部署配置。
要使用的API调用：
list— 检索现有配置。get— 获取特定配置的详细信息。update— 修改配置。candeploy— 检查部署资格。deploy— 部署配置。
要使用的API调用：
list— 检索现有配置。undeploy— 取消部署配置。delete— 删除配置。
在仅一个API调用中，您可以使用forceDelete参数取消部署和删除配置。
要使用的API调用：
list— 检索现有配置。delete（带forceDelete参数） — 强制在单个步骤中删除已部署的配置。
| note |
|---|
| NOTE |
| 更新已部署的配置后需要进行重新部署。 |
要使用的API调用：
list— 检索现有配置。get— 获取特定配置的详细信息。update— 修改配置。undeploy— 在应用更改之前取消部署配置。candeploy— 检查部署资格。deploy— 部署更新的配置。