Check Task Status

get

/dhcs/management/api/v1/status/{taskID}

This api checks the status of a task.

Request

Supported Media Types

• application/json

Path Parameters

• taskID: string
  Task ID created when obtaining cluster metrics.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Authorization Header value format: 'Bearer [authId]'

Response

Supported Media Types

• application/json

200 Response

Status retreived

Body ()

Root Schema : Status

Type: object

Show Source

• currentstatus: string
  Status of task progress
• httpcode: integer(int32)
  Httpcode of Response
• origin: string
  Server where the task request originated
• response: string
  API response
• taskID: string
  Task ID created when obtaining cluster metrics

{
    "type":"object",
    "properties":{
        "taskID":{
            "type":"string",
            "description":"Task ID created when obtaining cluster metrics"
        },
        "httpcode":{
            "type":"integer",
            "format":"int32",
            "description":"Httpcode of Response"
        },
        "currentstatus":{
            "type":"string",
            "description":"Status of task progress"
        },
        "origin":{
            "type":"string",
            "description":"Server where the task request originated"
        },
        "response":{
            "type":"string",
            "description":"API response"
        }
    }
}

400 Response

Bad Request

403 Response

Forbidden

500 Response

Internal Server error