ml deployment-job list

Retrieve the current job status. The system applies a maximum limit of jobs that are retained by the system. Only most recent 300 jobs (system configurable) are preserved. The system purges older jobs.

Syntax

cpd-cli ml deployment-job list \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--deployment-id=<deployment-id>] \
[--include=<comma-separated-list-of-response-fields>] \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-profile-name> \
[--quiet] \
[--raw-output=true|false] \
--space-id=<space-identifier> \
[--state=<state-filter-value>] \
[--tag-value=<comma-separated-tag-value-list>] \
[--verbose]

Arguments

The ml deployment-job list command has no arguments.

Options

Option Description
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--deployment-id Specify a 'deployment_id' to use as a filter value.
Status
Optional.
Syntax
--deployment-id=<deployment-id>
Default value
No default.
Valid values
A valid deployment_id.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--include Retrieves only fields from the 'decision_optimization' and 'scoring' sections. The output response fields are specified as a comma-separated list. The option retrieves all fields when not specified.
Status
Required.
Syntax
--include=<comma-separated-list-of-response-fields>
Default value
No default.
Valid values
A comma-separated list of field names.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--state Specify a state filter value to retrieve resources. Allowed values are 'initializing', 'updating', 'ready' and 'failed'.
Status
Optional.
Syntax
--state=<state-filter-value>
Default value
No default.
Valid values
initializing, updating, ready, and failed.
--tag-value Specify a comma-separated tag value list. Only resources with the specified tag values are returned.
Status
Optional.
Syntax
--tag-value=<comma-separated-tag-value-list>
Default value
No default.
Valid values
A valid comma-separated tag value list.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Table 1: Command options

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Best practice: Setting up installation environment variables.
Specify the environment variables in a script file.
deployment_name = "script_batch_deployment"
space_id = <The deployment space identifier>
Get the deployment job.
cpd-cli ml deployment-job list \
--deployment-id=${deployment_name} \
--jmes-query="resources[0].metadata.id" \
--output=json \
--raw-output \
--space-id=${space_id}