Querying Log Download Progress

Function

This interface is used to query the log download progress.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/LogServices/progress

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Instruction

Request:

GET https://10.10.10.10/redfish/v1/Systems/LogServices/progress

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/LogServices/progress",
    "@odata.type": "#Task.v1_6_0.Task",
    "@odata.id": "/redfish/v1/Systems/LogServices/progress",
    "Id": "Log Collection Task",
    "Name": "Log Collection Task",
    "Description": "Get download logs progress.",
    "TaskState": "empty",
    "PercentComplete": 0
}

Response code: 200

Output Description

Table 1 Operation output description

Field

Type

Description

@odata.context

Character string

OData description of a resource model.

@odata.id

Character string

Path to access a resource.

@odata.type

Character string

Resource type.

Id

Character string

Resource ID.

Name

Character string

Resource name.

Description

Character string

Resource description.

TaskState

Character string

Log download status.

PercentComplete

Number

Log download progress.