全部产品
云市场

服务型机器人调用(新)-form-data

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

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

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

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

请求参数(Body):

参数 类型 描述
config String 见config参数说明
appUuid String 通过获取市场中所有服务型应用列表的接口查询的appUuid

config参数说明:
config是一个一维的 json object 对象。

  1. {
  2. "appParams": "{\"params\":\"cserver\"}",
  3. "robotUuid": "499a9ed1-43e1-49fb-8feb-577da4xxxxxx",
  4. "callbackUrl": "",
  5. "timeout": 0
  6. }
key 类型 必选 可选值 默认值 说明
appParams string - - 应用的参数json对象的序列化string,注意转义。
robotUuid string - - 服务型机器人的唯一识别符,如果不指定,则会随机选择一个空闲的服务型机器人。
callbackUrl string - - 回调的url地址,如果有指定这个值,那么需要保证这个接口地址是可以直接调用到的。目前没有鉴权的能力。服务端会以POST的方式进行调用,返回的结果,会放在request的body中。
timeout int - 3600 任务最大等待时间(单位秒)。默认值为一小时。

接口回调数据说明:
回调的数据,是在机器人执行的应用中,调用api:rpa.workbench.``task_result(string) 写入的,写入的string需要是一个标准的json object对象。
callbackUrl 需要满足如下条件:

  1. http 或 https 的 post 请求。
  2. 接口免登
  3. Content-type:application/x-www-form-urlencoded
  4. 数据采用 form 表单方式发送,键值为:data

请求示例:

  1. curl -H "accessKey:54f7261d92xxxxxx" -H "accessKeySecret:b485d705-91e9-426d-b8d2-3f0b3cxxxxxx" --form "appUuid=ae293b38-d63b-4e4a-867b-bae4a9xxxxxx" --form "config={}" http://rpa.aliyun.com/rpa/api/ak/server/run

正常返回示例:

  1. {
  2. "success": true,
  3. "code": 0,
  4. "msg": "SUCCESS",
  5. "data": {
  6. "taskId": "48c1e663-ae81-42cc-94c6-aaf7af13xxxx",
  7. "resultUrl": "/rpa/api/ak/server/result?uuid=48c1e663-ae81-42cc-94c6-aaf7af13xxxx"
  8. },
  9. "pager": null
  10. }
字段 描述
success 这个接口内部运行是否成功
code 这个接口内部运行状态码,成功为0
msg 这个接口内部运行后的信息描述,成功为“SUCCDESS”
data taskId 任务id,用于查询任务运行状态使用
resultUrl 任务运行结果的查询接口
page 分页信息(请忽略这个字段)

失败返回示例:

错误码定义:

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