list-deployments¶
- subtitle
List deployments.
- version
0.9.126
Description¶
Lists deployments.
list-deployments
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
Synopsis¶
list-deployments
[--sorts <value>]
[--filters <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--sorts
(array)
The sort criteria
Syntax:
"string" "string" ...
--filters
(array)
The filter criteria
Syntax:
"string" "string" ...
--max-items
(integer)
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
nextToken
will be provided in the output that you can use to resume pagination. ThisnextToken
response element should not be used directly outside of the CDP CLI. This option cannnot be combined with theno-paginate
CLI option. If no max-items value is specified, then a default value of 20 is used.
--starting-token
(string)
A token to specify where to start paginating. This is the
nextToken
from a previously truncated response.
--page-size
(integer)
The size of each page. Generally this does not need to be set and the default page size used is appropriate.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
nextToken -> (string)
The page token for requesting the next page of results.
deployments -> (array)
The listing of deployments in this page
item -> (object)
A deployment summary
crn -> (string)
The deployment CRN
name -> (string)
The deployment name
status -> (object)
The status of a deployment
detailedState -> (string)
The detailed state that the deployment is currently in
message -> (string)
Detail message relating to the current status of the deployment
state -> (string)
The state that the deployment is currently in.
service -> (object)
Metadata about a service
crn -> (string)
The crn of the service
name -> (string)
the name of the environment
cloudProvider -> (string)
the cloud provider
region -> (string)
the region within the cloud provider
environmentCrn -> (string)
The CDP Environment CRN
updated -> (integer)
Timestamp of the last time the deployment was modified
activeInfoAlertCount -> (integer)
Current count of active alerts classified as an info
activeWarningAlertCount -> (integer)
Current count of active alerts classified as a warning
activeErrorAlertCount -> (integer)
Current count of active alerts classified as an error
project -> (object)
Metadata about a project.
id -> (string)
The id of the project.
crn -> (string)
The crn of the project.
name -> (string)
The name of the group.
Form Factors¶
public