AddRobots

更新时间:
复制为 MD 格式

作用:使用指定无影账号批量添加服务型机器人

路径:rpa/openapi/raas/resource/AddRobots

类型:POST

使用方式:

  • 每次接口调用最多选择50个云资源进行纳管,超过50个请自行分批,多次调用

  • 接口返回操作成功仅表示服务端成功接收到该请求,因执行添加机器人需要时间,最终执行结果请以控制台展示或ListRobots查询结果为准

使用限制:

重要

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

请求参数:

名称

类型

是否必选

示例值

描述

RegionId

String

cn-hangzhou

希望添加的无影云电脑实例所在地域ID

目前支持的地域包括:

  • cn-hangzhou

  • cn-shanghai

  • cn-qingdao

  • cn-beijing

  • cn-zhangjiakou

  • cn-shenzhen

  • cn-chengdu

  • cn-hongkong

  • ap-southeast-1

InitInfo

Array of Json,序列化方式为simple

[{"DesktopId": "ecd-9jhz****m08lsxs9e","EndUserId":"example_account"}, {"DesktopId": "ecd-3gqs****m08lasd9e","EndUserId":"example_account"}]

  • 待纳管机器人信息。一次调用中最多传入50个云电脑实例ID

  • DesktopId是无影云电脑ID、必填

  • EndUserId是无影云电脑的便捷账户名,并且需要已经关联到此云电脑中,该字段内容选填。

  • 如果EndUserId为空,默认使用“阿里云RPA控制台-服务型机器人-配置-云资源管理配置”菜单中的“默认Windows登录账号”信息。

PackId

String

bv***rDl

机器人分组ID。为空则机器人会隶属于默认分组

WuyingConfigId

String

RA-0S****X5

  • 云资源管理配置id。RPA服务端将会使用此id对应的授权信息去调用云电脑的相关接口。

  • 如果您的租户下只有一个云资源管理配置,则可以为空

  • 如果您的租户下有多个云资源管理配置,则必填

  • 可在“阿里云RPA控制台-服务型机器人-配置-云资源管理配置”菜单查看

ConnectConfigAutoWrite

Boolean

false

  • 纳管时是否自动将连接配置文件添加到云电脑上的客户端中。

  • 默认值为 false。此种情况下,纳管过程还需要您手动在服务型机器人客户端中导入连接配置文件。

  • 建议使用true,同时配合ConnectConfigId=<连接配置id>使用。此种情况下,系统进行纳管时可自动将连接配置文件添加到客户端中,自动完成全过程。

ConnectConfigId

String

RC-p***EiYe

  • 机器人连接配置id,需要配合ConnectConfigAutoWrite=true使用

  • 可在“阿里云RPA控制台-服务型机器人-配置-机器人连接配置”菜单查看

ConnectConfigAutoCreate

Boolean

false

  • 为空时默认值为false

  • 仅适用于您的租户下没有连接配置文件时自动创建。此种情况需要参数值为true,同时ConnectConfigAutoWrite=true

  • 大部分情况下,您已经在RPA控制台上进行操作过纳管服务型机器人,系统已经自动生成了连接配置文件,因此本参数可不使用

返回参数:

返回参数公共字段请查阅返回结果,返回参数中的 data 字段为空

请求示例:

https://console-rpa.aliyun.com/rpa/openapi/raas/resource/AddRobots?
&InitInfo=%5B%7B%22DesktopId%22%3A%22ecd-9jhz6***l15u0unio%22%2C%20%22UserId%22%3A%22jinyun2%22%7D%5D
&PackId=9uB***vBS
&RegionId=cn-hangzhou
&公共请求参数

返回示例:

{
	"requestId": "f0375921-****-****-****-6a682d2f9d4e",
	"success": true,
	"code": 0,
	"msg": "调用成功",
	"msgCode": "result.success",
	"data": null,
	"pager": null,
	"instanceId": null
}