job
Manage IBM Watson Data Platform jobs and the scheduling service.
Extended description
Before you can complete certain Cloud Pak for Data setup and management tasks, you
must create a profile so that you can run the appropriate cpd-cli
commands. A profile enables the cpd-cli
to verify that you are a
Cloud Pak for Data user and that you have
the appropriate administrator permissions to complete a given task.
Prerequisites
cpd-cli
- Before you run any
cpd-cli
commands, ensure that you downloaded thecpd-cli
12.0.6 command line utility for your operating system and Cloud Pak for Data edition from: https://github.com/IBM/cpd-cli/releases. - Common core services
- The
job
commands are relevant only when common core services are installed.
Required permissions
The job
command requires cluster
administrator or similar roles.
Commands
Command | Description |
---|---|
job create |
Create a job in a specified project or space (either project_id or space_id must be set). |
job delete |
Delete a specific job in a project or space (either project_id or space_id must be set). |
job get |
Retrieve information for a single job that is associated with a specific project or space (either project_id or space_id must be set). |
job list |
List all jobs in the specified project or space (either project_id or space_id must be set). |
job run cancel |
Cancel a currently running job. |
job run create |
Start a specific job that is contained in a project or space (either project_id or space_id must be set). |
job run delete |
Delete a specific job run in a project or space (either project_id or space_id must be set). |
job run download-results |
Download the results of the complete job run to the locations that are specified in the output paths, which defines a output map (for example, VAR1=/tml/outputs/var1 VAR2=/tml/outputs/var2). |
job run get |
Retrieve the information for a single job run from a specific project or space (either project_id or space_id must be set). |
job run list |
List the job runs for a specific job in a specific project or space (either project_id or space_id must be set). Only the metadata and certain elements of the entity component for each run are returned. |
job run logs |
Retrieve the job run logs for a specific project or space (either project_id or space_id must be set). |
job run pause |
Pause a running job run. |
job run resume |
Resume a paused job run. |
job run wait |
Wait until a job run completes, fails, or is canceled. |
job serving-name |
Retrieve the availability of a specific serving_name. serving_name must be globally unique and must be a combination of alphanumeric and underscore characters (between 1 and 36 characters). |
job update |
Update specific job attributes in a specific project or space (either project_id or space_id must be set). You must specify the updates by using the JSON patch format (described in RFC 6902). Use 'last_run_initiator' for the initiator of the last job run; use 'last_run_status' for the status of the last job run. |