Retrieve job list

Contributors

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

Retrieves a list of jobs from the database using the Cloud Manager backend service API endpoint. It lists all jobs pertaining to a Tenancy account. It is also possible to list the sub-jobs under a parent job. You can query based on the job type (volume_backup, restore), job status (RUNNING, COMPLETED, QUEUED, WARNING, FAILED), service type (CBS, SnapCenterService, K8s), and user.

Token usage: Cloud Manager user token.

Parameters

Name Type In Required Description

type

string

query

False

Job type

status

string

query

False

Job status

service

string

query

False

Service name

user

string

query

False

User

parentJobId

string

query

False

Parent 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

jobs

array[jobs]

False

Definitions

data

JSON data containing data specific to a job

jobs
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

Job description

description

string

False

error

string

False

Any error that might have occurred in the job execution

lastUpdateTime

number

False

Last update time for the job

resolution

string

False

Resolution for the error