NAME

DESCRIPTION

USAGE

oci analytics analytics-instance list [OPTIONS]

REQUIRED PARAMETERS

The OCID of the compartment.

OPTIONAL PARAMETERS

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

A filter to only return resources matching the capacity type enum. Values are case-insensitive.

Accepted values are:

OLPU_COUNT, USER_COUNT

A filter to only return resources matching the feature set. Values are case-insensitive.

Accepted values are:

ENTERPRISE_ANALYTICS, SELF_SERVICE_ANALYTICS

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

A filter to only return resources matching the lifecycle state. The state value is case-insensitive.

Accepted values are:

ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

Example:

50

A filter to return only resources that match the given name exactly.

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

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

The field to sort by (one column only). Default sort order is ascending exception of timeCreated column (descending).

Accepted values are:

capacityType, capacityValue, featureSet, lifecycleState, name, timeCreated

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:

ASC, DESC

GLOBAL PARAMETERS

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> 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/analytics/analytics-instance/list.html#cmdoption-compartment-id
    oci analytics analytics-instance list --compartment-id $compartment_id

AUTHOR

COPYRIGHT