"list"
******

* Description

* Usage

* Optional Parameters

* Global Parameters


Description
===========

Gets a list of backups based on the *databaseId* or *compartmentId*
specified. Either one of these query parameters must be provided.


Usage
=====

   oci db backup list [OPTIONS]


Optional Parameters
===================

--all

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

--backup-destination-type [text]

A filter to return only resources that match the given backup
destination type.

--compartment-id, -c [text]

The compartment OCID.

--database-id [text]

The OCID of the database.

--db-version [text]

A filter to return only resources that match the given database
version.

--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--lifecycle-state [text]

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

Accepted values are:

   ACTIVE, CANCELED, CANCELING, CREATING, DELETED, DELETING, FAILED, RESTORING, UPDATING

--limit [integer]

The maximum number of items to return per page.

--page [text]

The pagination token to continue listing from.

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

--shape-family [text]

If provided, filters the results to the set of database versions which
are supported for the given shape family.

Accepted values are:

   EXACC, EXADATA, EXADB_XS, SINGLENODE, VIRTUALMACHINE, YODA

--time-expiry-end [datetime]

The end of date-time range of expiration for the long term backups to
be fetched.

The following datetime formats are supported:


UTC with microseconds
---------------------

Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD

Example:

   2017-09-15T20:30:00.123456Z


UTC with milliseconds
---------------------

Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00Z


UTC with minute precision
-------------------------

Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30Z


Timezone with microseconds
--------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example:
2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800


Timezone with milliseconds
--------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00,
2017-09-15T12:30:00.456-0800


Timezone without milliseconds
-----------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00,
2017-09-15T12:30:00-0800


Timezone with minute precision
------------------------------

Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00,
2017-09-15T12:30-0800


Short date and time
-------------------

The timezone for this date and time will be taken as UTC (Needs to be
surrounded by single or double quotes) Format: ‘YYYY-MM-DD HH:mm’ or
“YYYY-MM-DD HH:mm” Example: ‘2017-09-15 17:25’


Date Only
---------

This date will be taken as midnight UTC of that day Format: YYYY-MM-DD
Example: 2017-09-15


Epoch seconds
-------------

Example: 1412195400

--time-expiry-start [datetime]

The start of date-time range of expiration for the long term backups
to be fetched.

The following datetime formats are supported:


UTC with microseconds
---------------------

Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD

Example:

   2017-09-15T20:30:00.123456Z


UTC with milliseconds
---------------------

Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00Z


UTC with minute precision
-------------------------

Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30Z


Timezone with microseconds
--------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example:
2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800


Timezone with milliseconds
--------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00,
2017-09-15T12:30:00.456-0800


Timezone without milliseconds
-----------------------------

Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00,
2017-09-15T12:30:00-0800


Timezone with minute precision
------------------------------

Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00,
2017-09-15T12:30-0800


Short date and time
-------------------

The timezone for this date and time will be taken as UTC (Needs to be
surrounded by single or double quotes) Format: ‘YYYY-MM-DD HH:mm’ or
“YYYY-MM-DD HH:mm” Example: ‘2017-09-15 17:25’


Date Only
---------

This date will be taken as midnight UTC of that day Format: YYYY-MM-DD
Example: 2017-09-15


Epoch seconds
-------------

Example: 1412195400

--type [text]

A filter to return only backups that matches with the given type of
Backup.


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"
