Questo contenuto non è disponibile nella lingua selezionata.

Chapter 30. External Backup Service


30.1. External Backup Service

30.1.1. DeleteExternalBackup

DELETE /v1/externalbackups/{id}

DeleteExternalBackup removes an external backup configuration given its ID.

30.1.1.1. Description

30.1.1.2. Parameters

30.1.1.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

30.1.1.3. Return Type

Object

30.1.1.4. Content Type

  • application/json

30.1.1.5. Responses

Expand
Table 30.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

30.1.1.6. Samples

30.1.2. GetExternalBackup

GET /v1/externalbackups/{id}

GetExternalBackup returns the external backup configuration given its ID.

30.1.2.1. Description

30.1.2.2. Parameters

30.1.2.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

30.1.2.3. Return Type

StorageExternalBackup

30.1.2.4. Content Type

  • application/json

30.1.2.5. Responses

Expand
Table 30.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageExternalBackup

0

An unexpected error response.

GooglerpcStatus

30.1.2.6. Samples

30.1.3. GetExternalBackups

GET /v1/externalbackups

GetExternalBackups returns all external backup configurations.

30.1.3.1. Description

30.1.3.2. Parameters

30.1.3.3. Return Type

V1GetExternalBackupsResponse

30.1.3.4. Content Type

  • application/json

30.1.3.5. Responses

Expand
Table 30.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetExternalBackupsResponse

0

An unexpected error response.

GooglerpcStatus

30.1.3.6. Samples

30.1.4. PostExternalBackup

POST /v1/externalbackups

PostExternalBackup creates an external backup configuration.

30.1.4.1. Description

30.1.4.2. Parameters

30.1.4.2.1. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

StorageExternalBackup

X

  

30.1.4.3. Return Type

StorageExternalBackup

30.1.4.4. Content Type

  • application/json

30.1.4.5. Responses

Expand
Table 30.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageExternalBackup

0

An unexpected error response.

GooglerpcStatus

30.1.4.6. Samples

30.1.5. PutExternalBackup

PUT /v1/externalbackups/{id}

PutExternalBackup modifies a given external backup, without using stored credential reconciliation.

30.1.5.1. Description

30.1.5.2. Parameters

30.1.5.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
30.1.5.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

ExternalBackupServicePutExternalBackupBody

X

  

30.1.5.3. Return Type

StorageExternalBackup

30.1.5.4. Content Type

  • application/json

30.1.5.5. Responses

Expand
Table 30.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageExternalBackup

0

An unexpected error response.

GooglerpcStatus

30.1.5.6. Samples

30.1.6. TestExternalBackup

POST /v1/externalbackups/test

TestExternalBackup tests an external backup configuration.

30.1.6.1. Description

30.1.6.2. Parameters

30.1.6.2.1. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

StorageExternalBackup

X

  

30.1.6.3. Return Type

Object

30.1.6.4. Content Type

  • application/json

30.1.6.5. Responses

Expand
Table 30.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

30.1.6.6. Samples

30.1.7. TestUpdatedExternalBackup

POST /v1/externalbackups/test/updated

TestUpdatedExternalBackup checks if the given external backup is correctly configured, with optional stored credential reconciliation.

30.1.7.1. Description

30.1.7.2. Parameters

30.1.7.2.1. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

V1UpdateExternalBackupRequest

X

  

30.1.7.3. Return Type

Object

30.1.7.4. Content Type

  • application/json

30.1.7.5. Responses

Expand
Table 30.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

30.1.7.6. Samples

30.1.8. TriggerExternalBackup

POST /v1/externalbackups/{id}

TriggerExternalBackup initiates an external backup for the given configuration.

30.1.8.1. Description

30.1.8.2. Parameters

30.1.8.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

30.1.8.3. Return Type

Object

30.1.8.4. Content Type

  • application/json

30.1.8.5. Responses

Expand
Table 30.8. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

30.1.8.6. Samples

30.1.9. UpdateExternalBackup

PATCH /v1/externalbackups/{externalBackup.id}

UpdateExternalBackup modifies a given external backup, with optional stored credential reconciliation.

30.1.9.1. Description

30.1.9.2. Parameters

30.1.9.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

externalBackup.id

 

X

null

 
30.1.9.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

ExternalBackupServiceUpdateExternalBackupBody

X

  

30.1.9.3. Return Type

StorageExternalBackup

30.1.9.4. Content Type

  • application/json

30.1.9.5. Responses

Expand
Table 30.9. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageExternalBackup

0

An unexpected error response.

GooglerpcStatus

30.1.9.6. Samples

Torna in cima
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2025 Red Hat