list-services¶

Description¶

Lists services.

list-services 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-services
[--sorts <value>]
[--search-term <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" ...

--search-term (string)

Search term to filter by name

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

services -> (array)

The services.

item -> (object)

The summary of the DF Service enabled in a CDP Environment

crn -> (string)

The service CRN.

environmentCrn -> (string)

The CDP Environment CRN

name -> (string)

The service name.

cloudPlatform -> (string)

The cloud platform of the service.

region -> (string)

The region of the service.

deploymentCount -> (integer)

The deployment count.

maxK8sNodeCount -> (integer)

The maximum number of kubernetes nodes that service may scale up under high-demand situations

status -> (object)

The status of a DataFlow enabled service.

state -> (string)

The state of the service.

message -> (string)

A status message for the service.

detailedState -> (string)

The detailed state of the service.

workloadVersion -> (string)

The workload version of the service.

runningK8sNodeCount -> (integer)

The number of kubernetes nodes currently running for this service.

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

clusterId -> (string)

Cluster id of the service, if enabled

instanceType -> (string)

The instance type of the kubernetes nodes currently in use by DataFlow for this service.

validActions -> (array)

Valid actions that can be applied based on the current state of the service

item -> (string)

proxyName -> (string)

The name of the proxy that is configured for the CDP environment

nextToken -> (string)

The page token for requesting the next page of results.

Form Factors¶

public