全部产品
云市场

list

更新时间:2020-03-04 14:53:30

查询所有服务型机器人

服务端需要V3.4.7及以上版本。

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

参数

类型

描述

accessKey

String

从控制台中获取到的 accessKey

accessKeySecret

String

从控制台中获取到的 accessKeySecret

请求参数(Params):

key

类型

必选

可选值

默认值

说明

clientName

string

-

-

客户端名称(模糊匹配)

currentPage

int

-

-

分页参数(当前页)

当两个分页参数都不传时默认查询全部

pageSize

int

-

-

页参数(每页数量)

请求示例:

  1. curl -H "accessKey:54f7261d92xxxxxx" -H "accessKeySecret:b485d705-91e6d-b8d2-3f0b3cxxxxxx" http://{rpahost}/rpa/api/ak/server/client/list -G --data-urlencode 'clientName=D-xxx' -d 'currentPage=1' -d 'pageSize=10'

正常返回示例:

  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": 573,
  28. "uuid": "ca0aad37-8b1c-4c05-8276-943cd7xxxxxx",
  29. "name": "MININT-xxx",
  30. "ip": "30.15.xxx.xxx",
  31. "macAddress": "AC:FD:CE:xx:xx:xx",
  32. "hasPlan": false,
  33. "connStatus": "unconnect",
  34. "connTime": ""
  35. }
  36. ],
  37. "pager": {
  38. "currentPage": 1,
  39. "totalPage": 1,
  40. "pageSize": 10,
  41. "total": 8,
  42. "limit": 10,
  43. "offset": 0
  44. }
  45. }

字段

描述

success

这个接口内部运行是否成功,枚举值详见code码说明

code

这个接口内部运行状态码,成功为0,枚举值详见code码说明

msg

这个接口内部运行后的信息描述,成功为“SUCCESS”,枚举值详见code码说明

data

id

应用id

uuid

机器人(客户端)的唯一识别符

name

应用的名称

ip

机器人(客户端)的IP

macAddress

机器人(客户端)的mac地址

hasPlan

是否已被计划

connStatus

机器人(客户端)的连接状态

connTime

机器人(客户端)连接的时间

pager

currentPage

当前所在的分页数

totalPage

总的分页数

pageSize

每页数量

total

查询结果的总数量

limit

当前页条数

offset

起始位置

connStatus:

连接状态(connStatus

描述

connecting

连接中

unconnect

未连接

locked

临时被锁定,等待执行任务

running

执行中

idle

空闲中

error

客户端状态异常

错误码定义:

错误码 错误信息 描述
404 请求资源不存在

请求资源不存在,请核对请求的路径

401 您无该功能的权限,请核对AK信息

您无该功能的权限,请核对AK信息

405 请求方法错误

请求方法错误,请核对你请求的方法

500 服务器错误,请稍后重试 服务器错误,请稍后重试