list-clusters¶

Description¶

Provides a detailed list of all available clusters.

Synopsis¶

  list-clusters
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--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¶

unreachableClusters -> (array)

List of errors for unreachable clusters.

item -> (object)

API error.

code -> (integer)

Error code.

message -> (string)

Error message.

status -> (string)

Error status.

clusterUrl -> (string)

Cluster URL.

requestId -> (string)

Request ID.

clusters -> (array)

List of clusters.

item -> (object)

Describes a Datalake, Datahub or Classic cluster.

crn -> (string)

Cluster CRN.

name -> (string)

Cluster name.

dataCenter -> (string)

Cluster data center.

clusterType -> (string)

Cluster type.

replicationEngineType -> (string)

Replication engine type.

clusterManagerType -> (string)

Cluster Manager type.

clusterManagerUrl -> (string)

Cluster Manager URL.

clusterUrl -> (string)

Cluster URL.

totalHosts -> (integer)

Total hosts on the cluster.

location -> (object)

Location object.

id -> (integer)

Location ID.

country -> (string)

Country.

city -> (string)

City.

latitude -> (double)

Latitude.

longitude -> (double)

Longitude.

stackCrn -> (string)

Stack CRN.

description -> (string)

Cluster description.

stackMajorVersion -> (string)

Stack major version.

stackVersion -> (string)

Stack version.

uuid -> (string)

Cluster UUID from Cloudera Manager if the cluster has CM backend.

environmentCrn -> (string)

CRN of the cluster’s environment.

knoxUrl -> (string)

Knox URL if the cluster was registered with one, null otherwise.

cloudAccountProvider -> (string)

Cloud account provider.

cmName -> (string)

Cloudera Manager name.

codProperties -> (object)

Additional properties for operational databases.

operationalDatabaseName -> (string)

Name of the corresponding operational database..

Form Factors¶

public