Skip to main content

Retrieve jobs

Contributors

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/job

Retrieves a list of jobs from the BlueXP SaaS application. You can query based on the job type and job status from the BlueXP SaaS application.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

type

string

query

False

status

string

query

False

accountId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

job

array[job]

False
Example response 
{
  "job": [
    {
      "id": "string",
      "working-environment-id": "string",
      "type": "string",
      "status": "string",
      "error": "string",
      "data": {
        "multi-volume-backup": {
          "volume": [
            {
              "id": "string",
              "status": "string",
              "error": "string"
            }
          ]
        },
        "restore": {
          "type": "string",
          "source": {
            "working-environment-id": "string",
            "working-environment-name": "string",
            "bucket": "string",
            "volume-id": "string",
            "volume-name": "string",
            "snapshot": "string"
          },
          "target": {
            "working-environment-id": "string",
            "working-environment-name": "string",
            "svm": "string",
            "volume-name": "string",
            "path": "string"
          },
          "batch": [
            {
              "id": "string",
              "status": "string",
              "error": "string",
              "file": [
                {
                  "path": "string",
                  "type": "string"
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

Definitions

See Definitions

volume

Name Type Required Description

id

string

False

volume ID

status

string

False

SUCCESS / FAILED status

error

string

False

error message in case of failure

multi-volume-backup

contains individual volume data for multi-volume-backup

Name Type Required Description

volume

array[volume]

False

Array of objects containing volume backup status/error with the volume ID

source

Optional object, present only in case of restore operation

Name Type Required Description

working-environment-id

string

False

working-environment-name

string

False

bucket

string

False

volume-id

string

False

volume-name

string

False

snapshot

string

False

target

Optional object, present only in case of restore operation

Name Type Required Description

working-environment-id

string

False

working-environment-name

string

False

svm

string

False

volume-name

string

False

volume-size

number

False

path

string

False

file

Name Type Required Description

inode

number

False

path

string

False

type

string

False

size

number

False

mtime

number

False

batch

Name Type Required Description

id

string

False

status

string

False

error

string

False

time

number

False

file

array[file]

False

restore

contains information about restore job - file and volume restore

Name Type Required Description

type

string

False

type of restore - file / volume

source

source

False

Optional object, present only in case of restore operation

target

target

False

Optional object, present only in case of restore operation

batch

array[batch]

False

Optional array present only in case of restore file operation

data

Optional object present in case of batch / individual operations running inside the main job only

Name Type Required Description

multi-volume-backup

multi-volume-backup

False

contains individual volume data for multi-volume-backup

restore

restore

False

contains information about restore job - file and volume restore

job

Name Type Required Description

id

string

False

working-environment-id

string

False

type

string

False

status

string

False

error

string

False

time

number

False

data

data

False

Optional object present in case of batch / individual operations running inside the main job only