列出迁移结果 API

Automation 360

关闭内容

内容

打开内容

下载 PDF

列出迁移结果 API

列出您运行的每个迁移的总体迁移结果。按选定的字段筛选以获得特定结果。

先决条件

注：您可以查看 Control Room APIs 在里面 Community Edition，但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。

您必须具有管理员角色或具有查看迁移权限的自定义角色。

支持的可筛选字段：使用请求正文中的以下筛选器可缩小结果范围。

createdBy：启动迁移的用户的唯一数字标识符（整数）。
numTotal：在特定迁移中 bots 迁移的总数，包括 bots 成功迁移、跳过和失败。
- numSuccess：在特定迁移中 bots 成功迁移的数量。
- numSkipped：已跳过 bots 包括已存在 bots 的，并且用户已选择不覆盖现有项 bots ("overwriteBots"： false)。
- numFailed：在特定迁移中 bots 未能迁移的数量。
updatedBy：启动迁移的用户的数字标识符。
updatedOn：开始迁移的日期和时间。

过程

将身份验证令牌添加到请求标头。

使用 POST 方法和端点 URL： <your_control_room_url>/v3/migration/list。

请求正文：

此请求搜索在指定日期之间开始的名称中包含单词 doc 的迁移。

{
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "gt",
        "field": "updatedOn",
        "value": "2020-04-08T00:00:00.001Z"
      },
      {
        "operator": "substring",
        "field": "name",
        "value": "doc"
      },
      {
        "operator": "lt",
        "field": "updatedOn",
        "value": "2020-04-13T00:00:00.001Z"
      }
    ]
  }
}

发送请求。

响应正文：

示例响应返回了 34 个迁移中的 3 个。

{
    "page": {
        "offset": 0,
        "total": 34,
        "totalFilter": 3
    },
    "list": [
        {
            "id": 21,
            "name": "Docs Test Migration",
            "startTime": "2020-04-09T21:09:25.590Z",
            "endTime": "2020-04-09T22:41:49.313Z",
            "createdBy": 17,
            "duration": "5543s",
            "numSuccess": 0,
            "numFailed": 0,
            "numSkipped": 0,
            "numTotal": 1,
            "status": "IN_PROGRESS",
            "updatedOn": "2020-04-09T21:09:25.590Z",
            "updatedBy": 17,
            "durationMillis": 5543723,
            "migrationType": "BOT"
        },
        {
            "id": 22,
            "name": "Docs Test Migration 02",
            "startTime": "2020-04-09T21:22:32.587Z",
            "endTime": "2020-04-09T22:41:49.313Z",
            "createdBy": 17,
            "duration": "4756s",
            "numSuccess": 0,
            "numFailed": 0,
            "numSkipped": 0,
            "numTotal": 1,
            "status": "IN_PROGRESS",
            "updatedOn": "2020-04-09T21:22:32.587Z",
            "updatedBy": 17,
            "durationMillis": 4756726,
            "migrationType": "BOT"
        },
        {
            "id": 24,
            "name": "Docs Test 03",
            "startTime": "2020-04-09T22:31:27.617Z",
            "endTime": "2020-04-09T22:41:49.317Z",
            "createdBy": 17,
            "duration": "621s",
            "numSuccess": 211,
            "numFailed": 0,
            "numSkipped": 0,
            "numTotal": 211,
            "status": "SUCCESSFUL",
            "updatedOn": "2020-04-09T22:31:27.617Z",
            "updatedBy": 17,
            "durationMillis": 621700,
            "migrationType": "BOT"
        }
    ]
}

注：有些响应字段未用于 Enterprise 11 迁移：

duration：不再用于迁移的旧字段。
migrationType：仅用于 Enterprise 10 迁移。不用于 Enterprise 11 迁移。

REST API 使用 HTTP 响应代码响应每个请求。有关响应代码，请参阅 API 响应代码.

后续步骤

要查看有关特定迁移的详细信息，请在按 ID API 列出的机器人迁移结果中输入特定迁移 ID。

发送反馈