list-internal

Description

An internal api to list all capacity requests.

Usage

oci capacity-management occ-capacity-request-collection list-internal [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

--occ-customer-group-id [text]

The customer group ocid by which we would filter the list.

Optional Parameters

--all

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

--display-name [text]

A filter to return only the resources that match the entire display name. The match is not case sensitive.

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

--id [text]

A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission.

--limit [integer]

The maximum number of items to return.

--namespace [text]

The namespace by which we would filter the list.

Accepted values are:

COMPUTE

--occ-availability-catalog-id [text]

A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created.

--page [text]

A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response.

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

--request-type [text]

A filter to return only the resources that match the request type. The match is not case sensitive.

Accepted values are:

NEW, TRANSFER

--sort-by [text]

The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top).

Accepted values are:

displayName, timeCreated

--sort-order [text]

The sort order to use, either ‘ASC’ or ‘DESC’.

Accepted values are:

ASC, DESC

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --connection-timeout, --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, --proxy, --query, --raw-output, --read-timeout, --realm-specific-endpoint, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

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/capacity-management/occ-customer-group/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-customer-group/create.html#cmdoption-display-name

    occ_customer_group_id=$(oci capacity-management occ-customer-group create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)

    oci capacity-management occ-capacity-request-collection list-internal --compartment-id $compartment_id --occ-customer-group-id $occ_customer_group_id