list

Description

Returns a list of deployments.

Usage

oci api-gateway deployment list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ocid of the compartment in which to list resources.

Optional Parameters

--all

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

--display-name [text]

A user-friendly name. Does not have to be unique, and it's changeable.

Example:

My new resource
--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

--gateway-id [text]

Filter deployments by the gateway ocid.

--lifecycle-state [text]

A filter to return only resources that match the given lifecycle state.

Example:

SUCCEEDED

Accepted values are:

ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
--limit [integer]

The maximum number of items to return.

--page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

--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 to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

Accepted values are:

displayName, timeCreated
--sort-order [text]

The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.

Accepted values are:

ASC, DESC