list-diagnostics¶

Description¶

List diagnostics requests.

list-diagnostics 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-diagnostics
--df-service-crn <value>
[--uuids <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--df-service-crn (string)

DataFlow Service CRN from which to list diagnostics.

--uuids (array)

List of UUIDs to list in the response.

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

diagnostics -> (array)

List of previous and current diagnostics requests for a given DataFlow Service.

item -> (object)

Object representation of a diagnostics request list item.

dfServiceCrn -> (string)

DataFlow Service CRN.

status -> (string)

Diagnostics status enum.

description -> (string)

User provided description of request.

destination -> (string)

DiagnosticsDestination enum.

bundleCloudPath -> (string)

Cloud storage path of the bundle, only populated for CLOUD_STORAGE destinations.

startTime -> (string)

Time from which to collect logs.

endTime -> (string)

Time to which to collect logs.

environmentComponents -> (array)

List of environment components included in the collection.

item -> (string)

DiagnosticsEnvironmentComponent enum.

collectionScope -> (string)

DiagnosticsCollectionScope enum.

deployments -> (array)

List of Flow deployments included in the collection.

item -> (string)

caseNumber -> (string)

Support case number associated with the collection.

uuid -> (string)

Uuid of the collection.

requestedTime -> (string)

Time at which the collection was requested.

nextToken -> (string)

The page token for requesting the next page of results.

Form Factors¶

public