Overview

The API of Data Recovery Service for CDP Private Cloud Control Plane .

Version information

Version : 0.9.128 (BETA)

License information

License : Apache 2.0
Terms of service : null

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Creates a backup for the control plane.

POST /api/v1/drscp/createBackup

Description

Creates an on-demand backup for the control plane including embedded database, Kubernetes objects, persistent volume, etc. Backup requests are processed asynchronously and instantaneously.

Parameters

Type Name Schema

Body

input
required

CreateBackupRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateBackupResponse

default

The default response on an error.

Error

Deletes a control plane backup.

POST /api/v1/drscp/deleteBackup

Description

Deletes an existing control plane backup. The call returns immediately.

Parameters

Type Name Schema

Body

input
required

DeleteBackupRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteBackupResponse

default

The default response on an error.

Error

Describes the backup.

POST /api/v1/drscp/describeBackup

Description

Returns the description of an existing control plane backup.

Parameters

Type Name Schema

Body

input
required

DescribeBackupRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeBackupResponse

default

The default response on an error.

Error

Restores the backup.

POST /api/v1/drscp/describeRestore

Description

Returns the description of a control plane restore operation.

Parameters

Type Name Schema

Body

input
required

DescribeRestoreRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeRestoreResponse

default

The default response on an error.

Error

Gets job logs.

POST /api/v1/drscp/getLogs

Description

Given the Crn, returns the corresponding job logs.

Parameters

Type Name Schema

Body

input
required

GetLogsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetLogsResponse

default

The default response on an error.

Error

Lists potential backup entities associated with the control plane.

POST /api/v1/drscp/listBackupEntities

Description

Lists potential backup entities. It includes the main control plane namespace and its corresponding vault namespace(if embedded).

Parameters

Type Name Schema

Body

input
required

ListBackupEntitiesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListBackupEntitiesResponse

default

The default response on an error.

Error

Lists backups

POST /api/v1/drscp/listBackups

Description

Lists backups associated with the control plane.

Parameters

Type Name Schema

Body

input
required

ListBackupsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListBackupsResponse

default

The default response on an error.

Error

Lists restores.

POST /api/v1/drscp/listRestores

Description

Lists restores associated with the control plane.

Parameters

Type Name Schema

Body

input
required

ListRestoresRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListRestoresResponse

default

The default response on an error.

Error

Restores backup.

POST /api/v1/drscp/restoreBackup

Description

Creates a new control plane from an existing backup.

Parameters

Type Name Schema

Body

input
required

RestoreBackupRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RestoreBackupResponse

default

The default response on an error.

Error

Definitions

Backup

Backup entry

Name Description Schema

backupCreationTime
optional

The time when the backup was created.

string

backupCrn
optional

The unique CRN of the backup.

string

backupJob
optional

The backup job name.

string

backupJobState
optional

The current state of the backup job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

string

backupName
optional

The display name of the backup.

string

backupPhase
optional

The phase of the backup operation. The values are PENDING, PRE_VALIDATION, SAVING_OBJECTS, CREATING_SNAPSHOTS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before backup. SAVING_OBJECTS indicates saving all the kubernetes resources related to the backup item. CREATING_SNAPSHOTS indicates creating a snapshot of all Kubernetes PersistentVolumeClaims related to the backup item and FINISHED indicates that the backup job has finished.

string

backupUpdatedTime
optional

The time when the backup was updated.

string

errors
optional

The errors from backup job.

< Message > array

includedNamespaces
optional

The list of namespaces to be included in backup.

< string > array

warnings
optional

The warnings from backup job.

< Message > array

CreateBackupRequest

Request object for the create backup request.

Name Description Schema

backupName
optional

Specified name for the backup.

string

itemName
optional

Name of the potential candidate for backup. It is optional in the case of control plane.

string

CreateBackupResponse

Response object for the create backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

DeleteBackupRequest

Request object for the delete backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

DeleteBackupResponse

Response object for the delete backup request.

Name Description Schema

deleteBackupCrn
required

The CRN of the kubernetes delete backup custom resource.

string

DescribeBackupRequest

Request object for the describe backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

DescribeBackupResponse

Request object for the describe backup request.

Name Description Schema

backup
required

The backup details.

Backup

DescribeRestoreRequest

Response object for the describe restore request.

Name Description Schema

restoreCrn
required

The unique CRN of the restore.

string

DescribeRestoreResponse

Response object for the describe restore request.

Name Description Schema

restore
required

The restore details.

Restore

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

GetLogsRequest

Request object for the get logs request.

Name Description Schema

crn
required

The CRN of the custom resource.

string

GetLogsResponse

Response object for the get backup logs request.

Name Description Schema

logs
required

Contains the logs of the operation.

string

JobState

The current state of a Data Recovery Service job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

Type : enum (NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED, TERMINATING)

ListBackupEntitiesRequest

Request object for the list entities request.

Type : object

ListBackupEntitiesResponse

Response object for the list entities request.

Name Description Schema

items
required

The list of potential candidates for backup. It should be a single entity that indicates the namespace which the control plane is running on.

< string > array

ListBackupsRequest

Request object for the list backups request.

Name Description Schema

backupName
optional

Specified name for the backup.

string

jobStates
optional

The job states to filter by.

< JobState > array

ListBackupsResponse

Response object for the list backups request.

Name Description Schema

backups
required

List of backups for the control plane.

< SimpleBackup > array

ListRestoresRequest

Request object for the list restores request.

Name Description Schema

backupCrn
optional

CRN of the backup.

string

jobStates
optional

The job states to filter by.

< JobState > array

ListRestoresResponse

Response object for the list restores request.

Name Description Schema

restores
required

List of restores for the control plane.

< SimpleRestore > array

Message

The message object used to display warnings and errors during DRS workflows

Name Description Schema

namespace
optional

The namespace that has the warning/error.

string

text
optional

The text message of the warning/error.

string

timestamp
optional

The time when the warning/error is hit.

string

Restore

Restore entry

Name Description Schema

backupCrn
optional

The CRN of the backup.

string

errors
optional

The errors from restore job.

< Message > array

excludedResources
optional

The list of resources to be excluded in restore.

< string > array

includedNamespaces
optional

The list of namespaces to be included in restore.

< string > array

restoreCreationTime
optional

The time when the restore was created.

string

restoreCrn
optional

The CRN of the restore.

string

restoreJob
optional

The restore job name.

string

restoreJobState
optional

The current state of the restore job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

string

restorePhase
optional

The phase of the restore operation. The values are PENDING, PRE_VALIDATION, STOPPING_APPS, DELETING_OBJECTS, DELETING_OBJECTS_PVC, RESTORING_PVC, RESTORING_OBJECTS, STARTING_APPS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before restore. STOPPING_APPS indicates stopping the microservices before data restore. DELETING_OBJECTS indicates deletion of Kubernetes resources other than PersistentVolumeClaims. DELETING_OBJECTS_PVC indicates deletion of Kubernetes PersistentVolumeClaims. RESTORING_PVC indicates creation of Kubernetes PersistentVolumeClaims. RESTORING_OBJECTS indicates creating of Kubernetes objects other than PersistentVolumeClaims. STARTING_APPS indicates starting of the microservices after data restore and FINISHED indicates the restore job has finished.

string

restoreUpdatedTime
optional

The updated time of the restore.

string

successConditions
optional

The list of conditions to be met for a successful restore.

< string > array

warnings
optional

The warnings from restore job.

< Message > array

RestoreBackupRequest

Request object for the restore backup request.

Name Description Schema

backupCrn
required

The CRN of the backup.

string

RestoreBackupResponse

Response object for the restore backup request.

Name Description Schema

restoreCrn
required

The CRN of the restore.

string

SimpleBackup

A simple backup entry for listBackup usage

Name Description Schema

backupCreationTime
optional

The time when the backup was created.

string

backupCrn
optional

The unique CRN of the backup.

string

backupJobState
optional

The current state of the backup job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

string

backupName
optional

The display name of the backup.

string

backupPhase
optional

The phase of the backup operation. The values are PENDING, PRE_VALIDATION, SAVING_OBJECTS, CREATING_SNAPSHOTS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before backup. SAVING_OBJECTS indicates saving all the kubernetes resources related to the backup item. CREATING_SNAPSHOTS indicates creating a snapshot of all Kubernetes PersistentVolumeClaims related to the backup item and FINISHED indicates that the backup job has finished.

string

SimpleRestore

A simple Restore entry for listRestore Usage

Name Description Schema

backupCrn
optional

The CRN of the backup.

string

includedNamespaces
optional

The list of namespaces to be included in restore.

< string > array

restoreCreationTime
optional

The time when the restore was created.

string

restoreCrn
optional

The CRN of the restore.

string

restoreJobState
optional

The current state of the restore job. The values are NOT_STARTED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, FAILED and TERMINATING. NOT_STARTED indicates the job has not started. IN_PROGRESS indicates the job is running. COMPLETED indicates the job has finished running successfully. PARTIALLY_FAILED indicates the job has finished running with some warnings. FAILED indicates the job has finished running with errors and TERMINATING indicates that the entity containing this job is being deleted.

string

restorePhase
optional

The phase of the restore operation. The values are PENDING, PRE_VALIDATION, STOPPING_APPS, DELETING_OBJECTS, DELETING_OBJECTS_PVC, RESTORING_PVC, RESTORING_OBJECTS, STARTING_APPS and FINISHED. PENDING indicates waiting for the job to start executing. PRE_VALIDATION indicates validation of the environment before restore. STOPPING_APPS indicates stopping the microservices before data restore. DELETING_OBJECTS indicates deletion of Kubernetes resources other than PersistentVolumeClaims. DELETING_OBJECTS_PVC indicates deletion of Kubernetes PersistentVolumeClaims. RESTORING_PVC indicates creation of Kubernetes PersistentVolumeClaims. RESTORING_OBJECTS indicates creating of Kubernetes objects other than PersistentVolumeClaims. STARTING_APPS indicates starting of the microservices after data restore and FINISHED indicates the restore job has finished.

string

Copyright © 2024 Cloudera, Inc. All rights reserved.