API概览

API概览

阿里云RPA提供以下服务端API。

机器人客户端

Name

Method

Path

Description

queryClientViews

get

/rpa/openapi/client/queryClientViews

查询客户端信息

queryTaskByClientIdAndStatus

get

/rpa/openapi/client/queryTaskByClientIdAndStatus

查询指定客户端对应的任务数

updateClientStatus

post

/rpa/openapi/client/updateClientStatus

修改客户端状态

updateClientDispatchMode

post

/rpa/openapi/client/updateClientDispatchMode

修改客户端是否可调度

updateClientInfo

post

/rpa/openapi/client/updateClientInfo

更新客户端信息

disconnectClient

post

/rpa/openapi/client/disconnectClient

断开客户端连接

deleteClient

post

/rpa/openapi/client/deleteClient

删除客户端

queryClientByUuid

get

/rpa/openapi/client/queryClientByUuid

根据客户端唯一标识符查询客户端信息

queryClientViewById

get

/rpa/openapi/client/queryClientViewById

查询客户端信息

queryMemberClientViews

get

/rpa/openapi/client/queryMemberClientViews

查询用户登录的客户端列表

应用

Name

Method

Path

Description

queryApps

get

/rpa/openapi/app/queryApps

获取应用列表

applyApp

post

/rpa/openapi/app/applyApp

申请应用

queryApplyList

get

/rpa/openapi/app/queryApplyList

获取申请列表

queryMyAppApplys

get

/rpa/openapi/app/queryMyAppApplys

查询我的申请列表

queryMyApps

get

/rpa/openapi/app/queryMyApps

查询我的app列表

approve

post

/rpa/openapi/app/approve

通过申请

reject

post

/rpa/openapi/app/reject

拒绝申请

cancel

post

/rpa/openapi/app/cancel

取消申请

queryAppApply

get

/rpa/openapi/app/

queryAppApply

获取已经申请app

任务

Name

Method

Path

Description

createTaskSchedule

post

/rpa/openapi/task/createTaskSchedule

创建计划任务

createServiceTask

post

/rpa/openapi/task/createServiceTask

创建服务型任务

queryTaskStatus

get

/rpa/openapi/task/queryTaskStatus

查询任务状态

queryServiceResult

get

/rpa/openapi/task/queryServiceResult

查询task结果

terminalTask

post

/rpa/openapi/task/terminalTask

根据taskUuid停止任务

queryTaskSchedules

get

/rpa/openapi/task/queryTaskSchedules

查询计划任务列表

queryLogs

get

/rpa/api/ak/server/task/queryLogs

获取计划任务运行日志

queryTaskScheduleBylientId

get

/rpa/api/ak/server/task/queryTaskScheduleByClientId

根据客户端唯一标识符获取计划任务

queryTaskByClientId

get

/rpa/api/ak/server/task/queryTaskByClientId

根据客户端唯一标识符获取任务