ml deployment list
Important: IBM Cloud Pak® for Data
Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.
Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.
Retrieve the list of deployments for the specified space.
Syntax
cpd-cli ml deployment list \
[--asset-id=<asset-id>] \
[--conflict] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--jmes-query=<jmespath-query>] \
[--name=<deployment-name>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--quiet] \
[--raw-output=true|false] \
[--serving-name=<serving-name>] \
--space-id=<space-identifier> \
[--state=<state-filter-value>] \
[--stats=true|false] \
[--tag-value=<comma-separated-tag-value-list>] \
[--type=<resource-type-value>] \
[--verbose]Arguments
The ml deployment list command has
no arguments.
Options
| Option | Description |
|---|---|
--asset-id |
Specify an 'asset_id'. Only
resources with the provided 'asset_id' are returned. 'asset_id' can be either 'model_id' or
'function_id'.
|
--conflict |
Returns whether 'serving_name' is
available for use. This option cannot be used with any other option except for
'serving_name'.
|
--context |
Specify the configuration context
name.
|
--cpd-config |
The Cloud Pak for Data
configuration location. For example,
$HOME/.cpd-cli/config.
|
--cpd-scope |
The Cloud Pak for Data space,
project, or catalog scope. For example,
cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
|
|
|
Display command
help.
|
--jmes-query |
Provide a JMESPath query to
customize the output.
|
--name |
Specify a deployment
name.
|
--output |
Specify an output format.
Valid formats include json, yaml, or text (the default
format).
|
--output-file |
Specify a file path where all
output is redirected.
|
--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.
|
--quiet |
Suppress verbose
messages.
|
--raw-output |
When set to true, single values
in
JSON output mode are not surrounded by quotes.
|
--serving-name |
Specify a 'serving_name'. The
deployment (if any) that contains the specified 'serving_name' is
returned.
|
--space-id |
Specify a space
identifier.
|
--state |
Specify a state filter value to
retrieve resources. Allowed values are 'initializing', 'updating', 'ready' and
'failed'.
|
--stats |
When set to true, the option
returns stats about deployments within a space or across spaces. This option cannot be combined with
any other option except for 'space_id'.
|
--tag-value |
Specify a comma-separated tag
value list. Only resources with the specified tag values are
returned.
|
--type |
Specify a resource type value.
Only resources that match the specified type are returned. Allowed type values are 'model',
'function', 'py_script', 'r_shiny', and 'do'.
|
--verbose |
Logs include more detailed
messages.
|
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 install variables script. For more information, see Best practice: Setting up install variables.
- Specify the environment variables in a script file.
-
deployment_name = "script_batch_deployment" space_id = <The deployment space identifier> - Update a script batch deployment in the production space.
-
cpd-cli ml deployment list \ --jmes-query="resources[0].metadata.id" \ --name=${deployment_name} \ --output=json \ --raw-output \ --space-id=${space_id}