阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

按 ID 检索设备池的详细信息

  • 已更新:1/29/2021
    • Automation 360 v.x
    • 探索
    • RPA 工作区

按 ID 检索设备池的详细信息

按特定设备池的数字标识符 (ID) 检索其详细信息。

先决条件

注: 您可以在 Control Room APIs 中查看 Community Edition,但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。

确保您具备以下条件才能使用此 API:

  • 查看和管理所有设备:查看和管理所有设备,包括其他用户注册的设备。
  • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
  • 设备池 ID:要检索其详细信息的设备池的唯一数字标识符。

此任务在 Control Room 中搜索特定设备池。API 传递设备池 {id},作为 URL 字符串的一部分。不需要请求正文。

过程

  1. 将认证令牌添加到请求标头。
  2. 使用 GET 方法和端点 URL: <your_control_room_url>/v2/devices/pools/{id}.
    在 URL 中输入设备池 ID。
    在此示例中,设备池 ID 为 27
    https://<your_control_room_url>/v2/devices/pools/27
  3. 发送请求
    当请求成功时,与传递的设备池 ID 相关的所有详细信息都将在响应正文中返回。
    在此示例中,与设备池 ID Bot Runners27 相关联的名称、自动化方案、状态、、所有者和使用者在响应正文中返回
    响应正文:
    {
      "id": "27",
      "name": "finance-device-pool",
      "description": "Finance department device pool",
      "automationScheme": "ROUND_ROBIN",
      "status": "CONNECTED",
      "timeSlice": "5",
      "timeSliceUnit": "MINUTES",
      "deviceIds": [
        "10",
        "23",
        "41"
      ],
      "ownerIds": [
        "48"
      ],
      "consumerIds": [],
      "detailedStatus": "ALL_DISCONNECTED",
      "updatedBy": "48",
      "updatedOn": "2020-04-27T14:29:05.655896Z",
      "createdBy": "48",
      "createdOn": "2020-04-25T10:46:44.642586Z",
      "tenantUuid": "c0a8f10a-717f-130b-8171-7f4762280000",
      "tenantId": "4"
    }
查看所列设备池的详细信息,以确定其是否符合您的 bot 部署要求。响应中的某些字段被用作其他 API 的输入。
评估这些详细信息:
id
IDControl Room 中唯一地标识此设备池。使用此 ID 作为 bot 部署的 poolId 的输入。

部署 bots API

名称
这是设备池的用户定义的名称。使用列表设备池任务中的筛选器筛选设备池名称

列出设备池 API

deviceIds
属于此设备池的 Bot Runner 设备的唯一数字 ID 列表。
ownerIds
此设备池所有者的 ID。设备池所有者可以查看、编辑或删除设备池。
consumerIds
可以在运行自动化时查看此设备的用户的 ID。

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

发送反馈