Job Methods

API interface for jobs

job.status()

Reads the status of the job passed in.

Parameters:

• name (String, Optional) – Name of the service - only show jobs that are attached to this service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
• id (String) – The Job ID. Job IDs are 32 hex digits.

Returns:

A dictionary with the following keys:

id

String: job id (32 hex digits).

type

String: textual description of what the job is doing, e.g. “SETUP-NEW-MINISERVER”.

status

String: some textual description of what the job is doing now.

service (optional)

String: The name of the service this is job is related to, if available. Services don’t have a name until they have been created.

finished

Boolean: set if job has finished.

error

Boolean: set if the job didn’t finish properly or was cancelled.