Task instance

GET

/redfish/v1/TaskService/Tasks/{TaskId}

The Task schema contains information about a task that the Redfish task service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.

Privilege: Login

NOTE: Based on the final status of the configuration job, different status codes are returned:

Job marked completed successfully: Status code 200 returned.

Job marked completed with errors: Status code 200 returned.

Job marked failed: Status code 400 returned.
NOTE: Features like Server Configuration Profile (SCP), SupportAssist Collection returns a task monitor URI instead of a task URI in the location header.

Request

Authorization

API Key

Add parameter in header

X-Auth-Token

Example:

X-Auth-Token: ********************

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Responses

🟢200成功

application/json

The response contains a representation of the Task resource

Bodyapplication/json

🔴500服务器错误

Request Example

Shell

JavaScript

Java

Swift

curl --location '/redfish/v1/TaskService/Tasks/' \
--header 'X-Auth-Token: <api-key>' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - 成功示例

{
    "@odata.etag": "W/\"gen-2\"",
    "@odata.id": "/redfish/v1/TaskService/Tasks/decommission",
    "@odata.type": "#Task.v1_7_4.Task",
    "EstimatedDuration": "PT0S",
    "Id": "decommission",
    "Messages": [
        {
            "Message": "could not find EEMI Message",
            "MessageArgs": [
                "IDRAC.NA"
            ],
            "MessageId": "Base.1.7.lookupError",
            "RelatedProperties": [],
            "Resolution": "internal error. no response action available.",
            "Severity": "OK"
        }
    ],
    "Name": "Task Decommission",
    "PercentComplete": 0
}

Modified at 2026-03-04 06:02:26

Task instance

TelemetryService instance