ListRobots-机器人流程自动化(RPA)-阿里云帮助中心

作用：查询机器人列表

路径：/rpa/openapi/raas/resource/ListRobots

类型：GET

使用方式：

重要

本接口中涉及同步调用云产品API会产生一定耗时，建议调用时使用NeedCloudResourceStatus=false，以缩短请求等待时间。

使用限制：

重要

接口调用限制详见调用限制。

请求参数：

名称	类型	是否必选	示例值	描述
RobotRunStatus	String	否	idle	支持查询机器人运行状态：空闲（idle）、忙碌（busy）为空表示没有此筛选条件
PackId	String	否	bv2XPrDl	机器人分组ID，不能和RobotIds入参同时使用为空表示没有此筛选条件
RobotIds	Array of String，序列化方式：simple	否	["6579633 **** D178CAC2FCBD5BD0B4EC", "11DC817 **** 4E463B1E538436035653"]	机器人ID，不能和PackId入参同时使用以逗号分隔可以传入一个或多个（一次最多同时查询50个，超过请自行分批）为空表示没有此筛选条件
CurrentPage	Integer	否	1	当前页码，默认第1页
PageSize	Integer	否	20	每页显示记录数，默认每页20个，最大能返回100条数据
RobotAuthorizedStatus	String	否	authorized	机器人授权状态。可传入已授权（authorized）或未授权（unauthorized）这两种状态为空表示没有此筛选条件
RobotConnectStatus	String	否	connected	机器人连接状态。可传入已连接（connected）或未连接（notConnected）这两种状态为空表示没有此筛选条件
MachineInstanceId	String	否	ecd-******og6wmjf6xuz	云资源实例ID，目前仅支持传入单个无影云电脑的实例ID（DesktopId）为空表示没有此筛选条件
NeedCloudResourceStatus	String	否	true	是否同步查询云资源状态为空或true，接口内部同步调用无影云电脑相关接口进行查询，同时返回云电脑状态，会产生一定耗时 false，则不查询无影云桌面状态，可缩短接口等待时间

返回参数：

返回参数公共字段请查阅返回结果，返回参数中的 data 字段说明如下：

名称	类型	示例值	描述
RobotId	String	11DC817A ****** E463B1E538436035653	机器人ID
RobotName	String	D-M70ANL7V-0904 建议替换为exampleName	机器人名称
PackId	String	bv2XPrDl	机器人分组ID
MachineType	String	EDS	云资源的类型，目前仅支持无影云电脑（EDS）
MachineInstanceId	String	ecd-9s******yzo5y7i8	云资源实例ID，目前仅支持使用无影云电脑的实例ID（DesktopId）
RobotRunStatus	String	idle	机器人运行状态。空闲（idle）、忙碌（busy）状态。若机器人未连接，显示为“-”
RobotConnectStatus	String	connected	机器人连接状态。已连接（connected）和未连接（notConnected）状态
RobotAuthorizedStatus	String	authorized	机器人授权状态。已授权（authorized）和未授权（unauthorized）状态
CloudResourceStatus	String	Running	云资源状态。枚举值为： Stopped：已关机。 Starting：启动中。 Rebuilding：变更中。 Running：运行中。 Stopping：停止中。 Expired：已过期。 Deleted：已删除。 Pending：等待中。本字段内容是通过调用云资源API获取（如无影云电脑），如调用云资源API失败，则值为“--”。若needCloudResourceStatus传入false，则本字段固定为null。
WuyingConfigId	String	RA-7yZBppUZ	云资源管理配置id
RobotRemark	String	机器人自定义备注文字	备注信息，默认为null

请求示例：

https://console-rpa.aliyun.com/rpa/openapi/raas/resource/ListRobots?
&CurrentPage=1
&RobotIds=100
&RobotRunStatus=6579633385B0D******2FCBD5BD0B4EC
&公共请求参数

返回示例：

{
	"code": 0,
	"data": [{
        "RobotId": "6579633385******CAC2FCBD5BD0B4EC",
        "RobotName": "hz6m****u0unio",
        "PackId": "Qq****m3t",
        "MachineType": "EDS",
    	"MachineInstanceId": "ecd-9jh******15u0unio",
        "RobotRunStatus": "-",
        "RobotConnectStatus": "notConnected",
        "RobotAuthorizedStatus": "authorized",
        "CloudResourceStatus": "Running",
        "WuyingConfigId": "RA-7yZBppUZ",
    	"RobotRemark": "-"
	}],
	"msg": "调用成功",
	"msgCode": "result.success",
	"pager": {
		"currentPage": 1,
		"limit": 100,
		"offset": 0,
		"pageSize": 100,
		"total": 1,
		"totalPage": 1
	},
	"success": true
}