Retrieve an application backup
GET /accounts/{account_id}/topology/v1/appBackups/{appBackup_id}
Returns the stored Application Backup API resource in the JSON response body.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
appBackup_id |
string |
path |
True |
ID of the appBackup collection to list |
Response
Status: 200, Returns the stored Application Backup API resource in the JSON response body.
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
name |
string |
True |
JSON string containing a user-specified name for the backup. If not specified, or when backups are initiated by a schedule, the system will assign a name for the backup. Defined values are:
|
bucketID |
string |
True |
JSON string containing an optional bucket ID that indicates where the backup will be stored on create. If not specified, a system-selected bucket is used. If no buckets are available, an error will be returned on create. Defined values are:
|
snapshotID |
string |
False |
JSON string containing the snapshot that was used to create the backup. To create the backup, a snapshot ID associated with the application being backed up can be specified on create. If not specified, a new snapshot will be created for the backup. Defined values are:
|
scheduleID |
string |
False |
JSON string containing an optional schedule ID that indicates that the backup was triggered by a schedule and which schedule triggered the backup. Only present for backups initiated by a schedule. Defined values are:
|
state |
string |
True |
JSON string containing a value indicating the operational state of the backup. Defined values are:
|
stateUnready |
array[string] |
True |
JSON array of JSON strings, each indicating a reason why an application backup is unable to transition to "running", or why it has transitioned to "failed" or "removed". Defined values are:
|
hookState |
string |
False |
JSON string containing a value indicating the state of any execution hooks run as part of snapshot. Defined values are:
|
hookStateDetails |
array[type_astra_stateDetails] |
False |
JSON array of JSON objects which lists additional details about why "hookState" transitioned into "failed". If no details are available, this array will be empty.
|
backupCreationTimestamp |
string |
False |
JSON string containing a timestamp indicating when the backup was taken. Defined values are:
|
totalBytes |
number |
False |
JSON number containing the total number of bytes in the backup. |
bytesDone |
number |
False |
JSON number containing the number of bytes backed up for a running backup. When the backup is completed, it matches with the totalBytes field. |
percentDone |
number |
False |
JSON number containing the percentage complete for a running backup. When the backup is completed, it is set to "100". |
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example response
Response
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
|
invalidParams |
array[invalidParams] |
False |
List of invalid query parameters |
Example response
Response
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 500, Internal server error
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
False |
|
status |
string |
True |
|
correlationID |
string |
False |
Example error response
Definitions
See Definitions
type_astra_stateDetails
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
type_astra_label
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_astra_metadata
Client and service-specified metadata associated with the resource. Defined values are:
-
Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels.
Name | Type | Required | Description |
---|---|---|---|
labels |
array[type_astra_label] |
True |
|
creationTimestamp |
string |
True |
|
modificationTimestamp |
string |
True |
|
createdBy |
string |
True |
|
modifiedBy |
string |
False |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid query parameter |
reason |
string |
True |
Reason why the query parameter is invalid |