全部产品

queryTaskByTaskBatchId

调用地址:api-rpa.aliyun.com/rpa/openapi/task/queryTaskByTaskBatchId

调用方式:GET

返回类型:JSON

接口说明:根据任务批次唯一标识符(taskBatchId)查询计划任务信息

请求参数

名称

类型

是否必选

示例值

描述

taskBatchId

String

39f3c724-4c18-421b-a7e1-6032eb1b92e4

任务批次唯一标识符

currentPage

Integer

1

展示页码

pageSize

Integer

1

每页展示记录数

返回参数

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

名称

类型

示例值

描述

uuid

String

8c809cdf-adba-44fb-b7c0-f53c6f4cc734

计划任务唯一标识符

taskBatchId

String

39f3c724-4c18-421b-a7e1-6032eb1b92e4

任务批次唯一标识符

appId

String

fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d

应用唯一标识符

appName

String

TestAPP1

应用名称

clientId

String

45E2D8F778B0A38C85344B6B2EF10FD4

机器人客户端id

status

String

completion

计划任务状态

result

String

任务状态:

任务执行结果

beginTime

String

2020-05-20 14:43:00

任务开始时间

endTime

String

2020-05-20 14:43:18

任务结束时间

triggerType

String

schedule

触发类型

taskTrigger

String

null

触发器

client

uuid

String

45E2D8F778B0A38C85344B6B2EF10FD4

客户端UUID

groupId

String

b8e097d8-605c-47cf-a5a3-db5d13f8b4ca

企业唯一表示符

clientType

String

robot

客户端类型

name

String

test

客户端名称

ip

String

10.30.88.168

客户端ip

macAddress

String

00:16:3E:04:36:AD

客户端Mac地址

status

String

authorized

客户端认证状态

dispatchMode

String

unmanned

调度模式

示例

请求示例:

https://api-rpa.aliyun.com/rpa/openapi/task/queryTaskByTaskBatchId?<公共请求参数>
&taskBatchId="39f3c724-4c18-421b-a7e1-6032eb1b92e4"
&currentPage=1
&pageSize=1

返回示例:

{
    "requestId":"68fdbb04-f13c-4448-a061-cd62daaa2df9",
    "success":true,
    "code":0,
    "msg":"调用成功",
    "msgCode":"result.success",
    "data":[
        {
            "uuid":"f3b6a957-3a8e-4486-aa84-9b581e24366b",
            "taskBatchId":"39f3c724-4c18-421b-a7e1-6032eb1b92e4",
            "appId":"fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d",
            "appName":"TestAPP1",
            "clientId":"45E2D8F778B0A38C85344B6B2EF10FD4",
            "status":"completion",
            "result":"任务状态:",
            "beginTime":"2020-05-20 14:43:00",
            "endTime":"2020-05-20 14:43:18",
            "triggerType":"schedule",
            "taskTrigger":null,
            "client":{
                "uuid":"45E2D8F778B0A38C85344B6B2EF10FD4",
                "groupId":"b8e097d8-605c-47cf-a5a3-db5d13f8b4ca",
                "clientType":"robot",
                "name":"test",
                "ip":"10.30.88.168",
                "macAddress":"00:16:3E:04:36:AD",
                "status":"authorized",
                "dispatchMode":"unmanned"
            }
        }
    ],
    "pager":{
        "currentPage":1,
        "totalPage":1,
        "pageSize":1,
        "total":1,
        "limit":1,
        "offset":0
    }
}