list
¶
Description¶
Gets a list of Data Safe private endpoints.
Required Parameters¶
-
--compartment-id
,
-c
[text]
¶
A filter to return only resources that match the specified compartment OCID.
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 resources that match the specified display name.
-
--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]
¶
A filter to return only resources that match the specified lifecycle state.
Accepted values are:
ACTIVE, CREATING, DELETED, DELETING, FAILED, NA, UPDATING
-
--limit
[integer]
¶
For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.
-
--page
[text]
¶
For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.
-
--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 specify only one sort order (sortOrder). The default order for TIMECREATED is descending. The 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 ascending (ASC) or descending (DESC).
Accepted values are:
ASC, DESC
-
--vcn-id
[text]
¶
A filter to return only resources that match the specified VCN OCID.
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-rc-file
, --config-file
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --query
, --raw-output
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -v