list-environments¶

Description¶

Returns the list of environments along with the CLO Data Hub details if it’s enabled.

list-environments 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-environments
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--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. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 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¶

nextPageToken -> (string)

The page token for requesting the next page of results.

totalEnvironments -> (integer)

This field represents the total number of environments.

environments -> (array)

The list containing environment details.

item -> (object)

The environment details.

environmentName -> (string)

The name of the environment.

environmentCrn -> (string)

The CRN of the environment.

isCloEnabled -> (boolean)

The flag indicating if CLO is enabled. If enabled it is true else false.

datahubName -> (string)

The name of the CLO Data Hub. If CLO is not enabled it will be null.

datahubCrn -> (string)

The CRN of the CLO Data Hub. If CLO is not enabled it will be null.

cloudPlatform -> (string)

The cloud platform of the environment, possible values are AZURE or AWS.

status -> (string)

The CLO Data Hub status. If CLO is not enabled it will be null.

Form Factors¶

public