全部产品

查询组织内的服务型机器人的列表(旧)

更新时间:2020-02-03 16:21:20

适用于服务端版本V3.4.4-V3.4.6

调用地址:http://{rpahost}/rpa/api/ak/server/client/list
调用方式:GET
返回类型:JSON
请求参数(Headers):

参数 类型 描述
accessKey String 从控制台中获取到的 accessKey
accessKeySecret String 从控制台中获取到的 accessKeySecret

请求参数(Body): (无参数)

请求示例:

  1. curl -H "accessKey:54f7261d92xxxxxx" -H "accessKeySecret:b485d705-91e6d-b8d2-3f0b3cxxxxxx" http://{rpahost}/rpa/api/ak/server/client/list

正常返回示例:

  1. {
  2. "success": true,
  3. "code": 0,
  4. "msg": "SUCCESS",
  5. "data": [
  6. {
  7. "id": 1,
  8. "uuid": "63d2c2e8-8458-4355-80f0-ff1d6d26xxxx",
  9. "name": "服务型机器人-1",
  10. "ip": "fdb2:xxxx:f4e4:0:fd8c:ebdc:bd8b:xxxx",
  11. "macAddress": "00:1C:42:xx:xx:xx",
  12. "hasPlan": false,
  13. "connStatus": "unconnect",
  14. "connTime": ""
  15. },
  16. {
  17. "id": 2,
  18. "uuid": "9dc26e17-f1eb-4969-906a-30f4a1xxxxxx",
  19. "name": "服务型机器人-2",
  20. "ip": "fdb2:xxxx:f4e4:0:fd8c:ebdc:xxxx:xxxx",
  21. "macAddress": "00:1C:42:xx:xx:xx",
  22. "hasPlan": true,
  23. "connStatus": "unconnect",
  24. "connTime": ""
  25. },
  26. {
  27. "id": 3,
  28. "uuid": "dde6ec3e-cead-4edc-a74c-0486f9xxxxxx",
  29. "name": "服务型机器人-3",
  30. "ip": "30.40.xx.xx",
  31. "macAddress": "7C:xx:91:51:xx:xx",
  32. "hasPlan": true,
  33. "connStatus": "unconnect",
  34. "connTime": ""
  35. }
  36. ],
  37. "pager": null
  38. }
字段 描述
success 这个接口内部运行是否成功
code 这个接口内部运行状态码,成功为0
msg 这个接口内部运行后的信息描述,成功为“SUCCDESS”
data id 应用id
uuid 机器人(客户端)的唯一识别符
name 应用的名称
ip 机器人(客户端)的IP
macAddress 机器人(客户端)的mac地址
hasPlan 是否已被计划
connStatus 机器人(客户端)的连接状态
connTime 机器人(客户端)连接的时间
page 分页信息(请忽略这个字段)

connStatus:

连接状态(connStatus) 描述
connecting 连接中
unconnect 未连接
locked 临时被锁定,等待执行任务
running 执行中
idle 空闲中
error 客户端状态异常

失败返回示例:

错误码定义:

错误码 错误信息 描述
404 请求资源不存在 请求资源不存在,请核对请求的路径
401 您无该功能的权限,请核对AK信息 您无该功能的权限,请核对AK信息
405 请求方法错误 请求方法错误,请核对你请求的方法
500 服务器错误,请稍后重试 服务器错误,请稍后重试