How to call queryTaskByTaskBatchId to query scheduled task information-Robotic Process Automation(RPA)-阿里云帮助中心

URL: console-rpa.aliyun.com/rpa/openapi/task/queryTaskByTaskBatchId

Method: GET

Response format: JSON

Description: Queries information about a scheduled task by its task batch ID (taskBatchId).

Request parameters

Name	Type	Required	Example value	Description
taskBatchId	String	No	39f3c724-4c18-421b-a7e1-6032eb1b92e4	The unique ID of the task batch.
currentPage	Integer	No	1	Displaying page numbers
pageSize	Integer	No	1	The number of records per page.

Response parameters

For information about common response parameters, see Response parameters. The following table describes the fields in the data object.

Name	Type	Example	Description
uuid	String	8c809cdf-adba-44fb-b7c0-f53c6f4cc734	The unique ID of the scheduled task.
taskBatchId	String	39f3c724-4c18-421b-a7e1-6032eb1b92e4	The unique ID of the task batch.
appId	String	fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d	The unique ID of the application.
appName	String	TestAPP1	The application name.
clientId	String	45E2D8F778B0A38C85344B6B2EF10FD4	The robot client ID.
status	String	completion	The status of the scheduled task.
result	String	Task status:	The task execution result.
beginTime	String	2020-05-20 14:43:00	The task start time.
endTime	String	2020-05-20 14:43:18	The task end time.
triggerType	String	schedule	The trigger type.
taskTrigger	String	null	The trigger.
client

client parameters

Name	Type	Example value:	Description
uuid	String	45E2D8F778B0A38C85344B6B2EF10FD4	The client UUID.
groupId	String	b8e097d8-605c-47cf-a5a3-db5d13f8b4ca	The unique ID of the enterprise.
clientType	String	robot	The client type.
name	String	test	The client name.
ip	String	10.30.88.168	The client IP address.
macAddress	String	00:16:3E:04:36:AD	The client MAC address.
status	String	authorized	The client authentication status.
dispatchMode	String	unmanned	The scheduling mode.

Examples

Request example:

https://console-rpa.aliyun.com/rpa/openapi/task/queryTaskByTaskBatchId?<Common request parameters>
&taskBatchId="39f3c724-4c18-421b-a7e1-6032eb1b92e4"
&currentPage=1
&pageSize=1

Response example:

{
    "requestId":"68fdbb04-f13c-4448-a061-cd62daaa2df9",
    "success":true,
    "code":0,
    "msg":"The call was successful.",
    "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":"Task status:",
            "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
    }
}