Retrieve job details

Contributors

GET /api/account/{accountId}/v1/jobs/{jobId}

Retrieves the details of a specific job from the database by using the Cloud Manager backend service API endpoint. It retrieves the ID, job type (volume_backup, restore), job status (RUNNING, COMPLETED, QUEUED, WARNING, FAILED), service type (CBS, SnapCenterService, K8S), start time, end time, and user details of a specific job and its sub-jobs . It also retrieve the description, error, resolution, and last update time of the job.

Token usage: Cloud Manager user token.

Parameters

Name Type In Required Description

jobId

string

path

True

Job ID

accountId

string

path

True

Account ID

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Response

Status: 200, Default response
Name Type Required Description

id

string

False

Job ID

name

string

False

Name of the job

service

string

False

Service accessing the job API

status

string

False

Status of the current job

user

string

False

User that initiated the job

startTime

number

False

Time in milliseconds when the job started

endTime

number

False

Time in milliseconds when the job ended

data

data

False

JSON data containing data specific to a job

parentJobId

string

False

Job ID of the parent job under which the current job must be grouped

type

string

False

description

string

False

error

string

False

resolution

string

False

Resolution for the error

lastUpdateTime

number

False

Last update time for the job

subJobs

array[subJobs]

False

Example response

{
  "service": "CBS",
  "status": "RUNNING"
}

Definitions

data

JSON data containing data specific to a job

subJobs
Name Type Required Description

id

string

False

Job ID

name

string

False

Name of the job

service

string

False

Service accessing the job API

status

string

False

Status of the current job

user

string

False

User that initiated the job

startTime

number

False

Time in milliseconds when the job started

endTime

number

False

Time in milliseconds when the job ended

data

data

False

JSON data containing data specific to a job

parentJobId

string

False

Job ID of the parent job under which the current job must be grouped

type

string

False

Short description to group jobs

description

string

False

error

string

False

resolution

string

False

Resolution for the error

lastUpdateTime

number

False

Last update time for the job