Querying the Log Collection Task Progress

Function

Queries the log collection task progress.

Syntax

Operation type: GET

URL: https://{ip}:{port}/edgemanager/v1/logmgmt/dump/task?taskId={taskId}

Request message body: None

URL Parameters

**Table 1** Description
Parameter	Mandatory/Optional	Description	Value
taskId	Mandatory	ID of the task to be queried	A character string, including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.). The string starts with dumpMultiNodesLog, the length after which can be 1 to 128 characters, for example, dumpMultiNodesLog.eca14a007f930e5689652a30.

Usage Example

Request:

GET https://10.10.10.10:30035/edgemanager/v1/logmgmt/dump/task?taskId=dumpMultiNodesLog.eca14a007f930e5689652a30

Request message body: None

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "createdAt": "2023-08-23T17:06:56.28075167Z",
        "data": {
            "fileName": "edgeNodes.tar.gz"
        },
        "finishedAt": "2023-08-23T17:07:05.67786258Z",
        "progress": 100,
        "reason": "task succeeded",
        "startedAt": "2023-08-23T17:06:56.28095697Z",
        "status": "succeed",
        "taskId": "dumpMultiNodesLog.eca14a007f930e5689652a30"
    }
}

Response status code: 200

Output Description

**Table 2** Operation output description
Parameter	Type	Description
status	String	Error code
msg	String	Description
data	Object	Return value of a successful operation

**Table 3** data field description
Parameter	Type	Description
createdAt	String	Creation time
data	Object	Optional result
fileName	String	File name of collected logs
finishedAt	String	End time
progress	Number	Progress of a log collection task. The maximum value is 100.
reason	String	Reason why the task is in this state
startedAt	String	Start time
status	String	Task status: waiting: The task is waiting to be executed. processing: The task is being executed. aborting: The task is being terminated. succeed: The task succeeds. failed: The task fails. partiallyFailed: The task partially fails.
taskId	String	ID of the task to be queried

Parent topic: Log Collection APIs