list

Description

Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

Usage

oci data-flow pool list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--display-name [text]

The query parameter for the Spark application name.

--display-name-starts-with [text]

The displayName prefix.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--lifecycle-state [text]

The LifecycleState of the pool.

Accepted values are:

ACCEPTED, ACTIVE, CREATING, DELETED, DELETING, FAILED, SCHEDULED, STOPPED, STOPPING, UPDATING
--limit [integer]

The maximum number of results to return in a paginated List call.

--owner-principal-id [text]

The OCID of the user who created the resource.

--page [text]

The value of the opc-next-page or opc-prev-page response header from the last List call to sent back to server for getting the next page of results.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The field used to sort the results. Multiple fields are not supported.

Accepted values are:

timeCreated
--sort-order [text]

The ordering of results in ascending or descending order.

Accepted values are:

ASC, DESC

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/pool/list.html#cmdoption-compartment-id

    oci data-flow pool list --compartment-id $compartment_id