list-backups¶

Description¶

List all service backups.

list-backups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-backups
[--order <value>]
[--order-by <value>]
[--filter <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--order (string)

Order.

Possible values:

• ASC

• DESC

--order-by (string)

The ‘fieldname’ to order by, default “id”. Here ‘fieldname’ is one of (‘id’, ‘clusterID’, ‘cdeVersion’, ‘environment’, ‘environmentCrn’, ‘created’, ‘status’).

--filter (array)

Filter backups using ‘fieldname(operator)argument’ syntax. Here ‘fieldname’ is one of (‘id’, ‘clusterID’, ‘cdeVersion’, ‘environment’, ‘environmentCrn’, ‘created’, ‘status’) and ‘operator’ is one of (‘eq’, ‘noteq’, ‘lte’, ‘lt’, ‘gte’, ‘gt’, ‘in’, ‘notin’, ‘like’, ‘rlike’, ‘is’, ‘isnot’). Multiple filters are ANDed. For example, ‘status(eq)failed’.

Syntax:

"string" "string" ...

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 10 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

backups -> (array)

The backups.

item -> (object)

Service backup object.

id -> (integer)

Backup ID.

serviceID -> (string)

Service ID of a backed-up CDE service.

serviceName -> (string)

Name of a backed-up CDE service.

serviceVersion -> (string)

Version of a backed-up CDE service.

environmentName -> (string)

Name of CDP environment with which a backed-up CDE service was associated.

environmentCrn -> (string)

CRN of CDP environment with which a backed-up CDE service was associated.

creator -> (string)

The workload name of the user who created this backup.

creatorCrn -> (string)

CRN of of the user who created this backup.

cloudPlatform -> (string)

The cloud platform where a backed-up CDE service was enabled.

status -> (string)

Backup status.

created -> (string)

The time when the backup was created.

description -> (string)

Backup description.

errorMessage -> (string)

Error message, only set when there is an error.

archiveBasePath -> (string)

The path to the base location where the backups are stored.

archiveLocation -> (string)

Archive location under the base path.

nextToken -> (string)

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

Form Factors¶

public, private