[Beta]{class="badge informative"}

进程管理器API

使用Adobe Experience Platform中的进程管理器API列出进程定义、审查执行运行和管理定期计划。

快速入门

在使用API之前,请完成身份验证教程。 然后,在每个请求中包含这些标头:

  • 授权: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}
  • x-sandbox-name: {SANDBOX_NAME}
NOTE
有关Adobe Experience Platform中沙盒的更多信息,请参阅沙盒概述文档。

列出进程定义 list-process-definitions

您可以通过向/process-definitions端点发出GET请求来列出所有当前进程定义。

API格式

GET /process-definitions

查询参数

可用查询参数的列表。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
参数 说明
name 定义名称上不区分大小写的子字符串过滤器。
sort 要作为排序依据的字段。 支持的值为createdAt、updatedAt和name。 默认值为createdAt。
order 排序顺序。 支持的值为asc和desc。 默认值为desc。
pageSize 每页的项目数。 支持的范围是1到100。 默认值为100。
cursor 上一个调用返回的不透明分页光标。 与offset互斥。
offset 从零开始的偏移。 与cursor互斥。

请求

获取进程定义列表的示例请求。
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions?sort=updatedAt&order=desc&pageSize=2" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回包含进程定义列表的HTTP状态200。

检索进程定义列表时的示例响应。
code language-json
{
  "items": [
    {
      "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
      "name": "onboard-new-customer",
      "imsOrg": "{ORG_ID}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "prod",
      "tasks": [
          {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
            }
        }
      ],
      "createdAt": "2026-05-13T17:45:00Z",
      "updatedAt": "2026-05-13T17:45:00Z",
      "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
      },
      "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
      }
    }
  ],
  "offset": 0,
  "nextCursor": "opaque-pagination-cursor",
  "pageSize": 1,
  "total": 1,
  "hasMore": true
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2
字段 描述
definitionUuid 进程定义的ID。
name 进程定义的名称。
imsOrg 流程定义所属的组织的ID。
sandboxId 进程定义所属的沙盒的ID。
sandboxName 进程定义所属的沙盒的名称。
tasks 一个数组,其中包含与进程定义相关的任务对象。
tasks.id 任务的ID。
tasks.taskType 任务的类型。 可能的值包括wait、ingest-data、verify-profile-ingestion、run-segmentation、run-profile-export、trigger-activation、run-data-distiller和send-notification。
tasks.retry.maxAttempts 任务失败时重试任务的次数。
tasks.retry.backoffCoefficient
createdAt 创建进程定义的日期和时间。
updatedAt 上次更新流程定义的日期和时间。
createdBy 包含有关创建进程定义的用户的信息的对象。
updatedBy 一个对象,其中包含有关上次更新进程定义的用户的信息。

检索特定进程定义

您可以在提供进程定义ID的同时通过向/process-definitions端点发出GET请求来检索特定的进程定义。

API格式

GET /process-definitions/{DEFINITION_ID}
参数
说明
{DEFINITION_ID}
进程定义的ID。

请求

用于检索指定进程定义的示例请求。
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求会返回HTTP状态200,其中包含有关所请求的进程定义的信息。

检索特定进程定义时的示例响应。
code language-json
{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "name": "onboard-new-customer",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "tasks": [
        {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
        }
    }
    ],
    "createdAt": "2026-05-13T17:45:00Z",
    "updatedAt": "2026-05-13T17:45:00Z",
    "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
    },
    "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
    }
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2
字段 描述
definitionUuid 进程定义的ID。
name 进程定义的名称。
imsOrg 流程定义所属的组织的ID。
sandboxId 进程定义所属的沙盒的ID。
sandboxName 进程定义所属的沙盒的名称。
tasks 一个数组,其中包含与进程定义相关的任务对象。
tasks.id 任务的ID。
tasks.taskType 任务的类型。 可能的值包括wait、ingest-data、verify-profile-ingestion、run-segmentation、run-profile-export、trigger-activation、run-data-distiller和send-notification。
tasks.retry.maxAttempts 任务失败时重试任务的次数。
tasks.retry.backoffCoefficient
createdAt 创建进程定义的日期和时间。
updatedAt 上次更新流程定义的日期和时间。
createdBy 包含有关创建进程定义的用户的信息的对象。
updatedBy 一个对象,其中包含有关上次更新进程定义的用户的信息。

列出进程定义运行 list-process-definition-runs

您可以通过向/runs端点发出GET请求并提供进程定义的ID,来检索进程定义的所有运行的列表。

API格式

GET /runs?{QUERY_PARAMETERS}

查询参数

参数
必需
描述
definitionUuid
是
要列出其运行的进程定义。
executionTrigger
否
筛选结果以由MANUAL或SCHEDULE启动。

请求

用于检索指定进程定义的所有手动运行的示例请求。
code language-shell
curl -X GET "https://aep-maestro.adobe.io/runs?definitionUuid=5b4e018b-f37c-4104-928b-b67148ce8537&executionTrigger=MANUAL" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求会返回HTTP状态200,其中包含有关进程定义运行的信息。

检索进程定义的运行时的示例响应。
code language-json
[
  {
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
  }
]
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
字段 描述
runId 进程定义运行的ID。
definitionUuid 运行所属的进程定义的ID。
definitionName 运行所属的进程定义的名称。
imsOrg 流程定义运行所属的组织的ID。
sandboxId 运行进程定义的沙盒所属的ID。
sandboxName 运行进程定义的沙盒所属的名称。
state 进程定义运行的状态。 可能的值包括PENDING、RUNNING、COMPLETED、FAILED、CANCELED、TERMINATED和TIMED_OUT。
submittedAt 提交流程定义运行的日期和时间。
startedAt 进程定义运行开始执行的日期和时间。
events 包含作为进程定义运行的一部分执行的任务的对象。
triggeredBy 执行进程定义的方法。 可能的值包括MANUAL或SCHEDULE。

获取特定的进程定义运行 get-process-definition-run

您可以在提供运行ID的同时通过向/runs端点发出GET请求来检索运行的特定进程定义。

API格式

GET /runs/{RUN_ID}
参数
说明
{RUN_ID}
进程定义运行的ID。

请求

用于检索指定的进程定义运行的示例请求。
code language-shell
curl -X GET "https://aep-maestro.adobe.io/runs/{RUN_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回HTTP状态200,其中包含有关指定进程定义运行的信息。

包含有关进程定义运行信息的示例响应。
code language-json
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
字段 描述
runId 进程定义运行的ID。
definitionUuid 运行所属的进程定义的ID。
definitionName 运行所属的进程定义的名称。
imsOrg 流程定义运行所属的组织的ID。
sandboxId 运行进程定义的沙盒所属的ID。
sandboxName 运行进程定义的沙盒所属的名称。
state 进程定义运行的状态。 可能的值包括PENDING、RUNNING、COMPLETED、FAILED、CANCELED、TERMINATED和TIMED_OUT。
submittedAt 提交流程定义运行的日期和时间。
startedAt 进程定义运行开始执行的日期和时间。
events 包含作为进程定义运行的一部分执行的任务的对象。
triggeredBy 执行进程定义的方法。 可能的值包括MANUAL或SCHEDULE。

启动进程定义运行 start-run

您可以通过向/runs端点发出POST请求来启动流程定义运行。

API格式

POST /runs

请求

启动流程定义运行的示例请求。
code language-shell
curl -X POST "https://aep-maestro.adobe.io/runs" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "inputs": {
      "customerEmail": "alice@example.com",
      "orgName": "ACME Corp"
    }
  }'
table 0-row-3 1-row-3 2-row-3
属性 类型 描述
definitionUuid 字符串 要开始运行的进程定义的ID。
inputs 对象 可选对象,其中包含流程定义中所需的字段。

响应

成功的请求返回HTTP状态202 Accepted以及接受的运行详细信息。 执行是异步执行的,将立即返回state: PENDING。

启动进程定义运行时的示例响应。
code language-json
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "PENDING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
字段 描述
runId 新接受的运行的ID。
definitionUuid 运行的进程定义的ID。
definitionName 运行所属的进程定义的名称。
imsOrg 流程定义运行所属的组织的ID。
sandboxId 运行进程定义的沙盒所属的ID。
sandboxName 运行进程定义的沙盒所属的名称。
state 运行的状态。 由于此进程是异步的,因此将为PENDING。
submittedAt 提交流程定义运行的日期和时间。
startedAt 进程定义运行开始执行的日期和时间。
events 包含作为进程定义运行的一部分执行的任务的对象。
triggeredBy 执行进程定义的方法。 可能的值包括MANUAL或SCHEDULE。

检索进程定义计划 get-schedule

您可以通过向/process-definitions/{DEFINITION_ID}/schedule端点发出GET请求并提供进程定义的ID来获取进程定义的计划。

API格式

GET /process-definitions/{DEFINITION_ID}/schedule
参数
说明
{DEFINITION_ID}
拥有该计划的进程定义的ID。

请求

检索进程定义计划的示例请求。
code language-shell
curl -X GET "https://aep-maestro.adobe.io/process-definitions/{DEFINITION_ID}/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回HTTP状态200,其中包含有关进程定义计划的信息。

包含有关进程定义计划信息的示例响应。
code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
字段 描述
cron 计划的cron格式。 有关cron计划的详细信息,请阅读cron表达式格式文档。
paused 一个布尔值,表明计划是否暂停。
createdAt 创建计划的日期和时间。
updatedAt 上次更新计划的日期和时间。
createdBy 包含创建调度之用户的详细信息的对象。
updatedBy 包含上次更新计划的用户的详细信息的对象。

替换计划 replace-schedule

在提供进程定义的ID时,您可以通过向/process-definitions/{DEFINITION_ID}/schedule端点发出PUT请求来替换进程定义的计划。

API格式

PUT /process-definitions/{DEFINITION_ID}/schedule
参数
说明
{DEFINITION_ID}
拥有该计划的进程定义的ID。

请求

替换进程定义计划的示例请求。
code language-shell
curl -X PUT "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "cron": "0 0 * * *"
  }'
table 0-row-3 1-row-3
属性 类型 描述
cron 字符串 计划的cron格式。 有关cron计划的详细信息,请阅读cron表达式格式文档。

响应

更新计划时的示例响应。

成功的请求会返回包含更新计划的HTTP状态200。

code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

删除进程定义计划 remove-schedule

您可以删除附加到进程定义的计划,方法是在提供进程定义的ID的同时向/process-definitions/{DEFINITION_ID}/schedule端点发出DELETE请求。

API格式

DELETE /process-definitions/{DEFINITION_ID}/schedule
参数
说明
{DEFINITION_ID}
进程定义的ID。

请求

删除进程定义计划的示例请求。
code language-shell
curl -X DELETE "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回不带响应正文的HTTP 204。

暂停指定的计划 pause-schedule

您可以在提供进程定义ID的同时向/process-definitions/{DEFINITION_ID}/schedule:pause端点发出POST请求,以暂停进程定义的计划。

API格式

POST /process-definitions/{DEFINITION_ID}/schedule:pause
参数
说明
{DEFINITION_ID}
进程定义的ID。

请求

暂停计划的示例请求。
code language-shell
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:pause" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回HTTP状态200,其中包含有关调度的信息。

暂停计划时的示例响应。
code language-json
{
  "cron": "0 0 * * *",
  "paused": true,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

恢复指定的计划 resume-schedule

您可以在提供进程定义ID的同时向/process-definitions/{DEFINITION_ID}/schedule:resume端点发出POST请求,以恢复进程定义的计划。

API格式

POST /process-definitions/{DEFINITION_ID}/schedule:resume
参数
说明
{DEFINITION_ID}
进程定义的ID。

请求

恢复计划时的示例请求。
code language-shell
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:resume" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

响应

成功的请求返回HTTP状态200,其中包含有关调度的信息。

恢复计划时的示例响应。
code language-json
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
recommendation-more-help
experience-platform-help-process-manager