Retrieve an application backup for an app

10/23/2024 Contributors

PDFs

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/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 example: {{.Account}}
app_id	string	path	True	ID of the containing app resource
appBackup_id	string	path	True	ID of the appBackup collection to list

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

app_id

string

path

True

ID of the containing app 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: "application/astra-appBackup"
version	string	True	Version of the resource. Defined values are: "1.0" "1.1" "1.2"
id	string	True	Globally unique identifier of the resource. Defined values are: Conforms to the UUIDv4 Schema
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 assigns a name for the backup. Defined values are: Minimum length: 1 Maximum length: 63 Conforms to the DNS 1123 Label Schema
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: Conforms to the Astra Identifier Schema
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: Conforms to the Astra Identifier Schema
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: Conforms to the Astra Identifier Schema
state	string	True	JSON string containing a value indicating the operational state of the backup. Defined values are: "pending" - The application backup is scheduled for discovery "discovering" - The application backup is in the process of being discovered "running" - The application backup is running normally "completed" - The application backup has completed successfully "failed" - The application backup is in a permanent failure state "removed" - The application backup is not currently accessible "unknown" - The application backup state cannot be determined
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: Minimum length: 1 Maximum length: 127
hookState	string	False	JSON string containing a value indicating the state of any execution hooks run as part of a snapshot. Defined values are: "failed" - One or more execution hooks have failed "success" - There were zero or more applicable hooks and all were successful
hookStateDetails	array[type_astra_stateDetail]	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. Minimum items: 0
backupCreationTimestamp	string	False	JSON string containing a timestamp indicating when the backup was taken. Defined values are: Conforms to the ISO-8601 Date Time Schema
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	type_astra_metadata	True	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

type

string

True

Media type of the resource. Defined values are:

"application/astra-appBackup"

version

string

True

Version of the resource. Defined values are:

"1.0"
"1.1"
"1.2"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

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 assigns a name for the backup. Defined values are:

Minimum length: 1
Maximum length: 63
Conforms to the DNS 1123 Label Schema

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:

Conforms to the Astra Identifier Schema

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:

Conforms to the Astra Identifier Schema

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:

Conforms to the Astra Identifier Schema

state

string

True

JSON string containing a value indicating the operational state of the backup. Defined values are:

"pending" - The application backup is scheduled for discovery
"discovering" - The application backup is in the process of being discovered
"running" - The application backup is running normally
"completed" - The application backup has completed successfully
"failed" - The application backup is in a permanent failure state
"removed" - The application backup is not currently accessible
"unknown" - The application backup state cannot be determined

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:

Minimum length: 1
Maximum length: 127

hookState

string

False

JSON string containing a value indicating the state of any execution hooks run as part of a snapshot. Defined values are:

"failed" - One or more execution hooks have failed
"success" - There were zero or more applicable hooks and all were successful

hookStateDetails

array[type_astra_stateDetail]

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.

Minimum items: 0

backupCreationTimestamp

string

False

JSON string containing a timestamp indicating when the backup was taken. Defined values are:

Conforms to the ISO-8601 Date Time Schema

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

type_astra_metadata

True

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.

Example response

{
  "type": "application/astra-appBackup",
  "version": "1.2",
  "id": "bab39d53-2d04-5297-b92e-58df89a2117b",
  "name": "app-name-245",
  "bucketID": "0afbe357-a717-4c7a-8b3d-d0368959c8de",
  "scheduleID": "1fe83650-9b3c-41ef-bb25-a2910c19c33e",
  "state": "pending",
  "stateUnready": [],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request

Name	Type	Required	Description
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False
invalidParams	array[invalidParams]	False	List of invalid query parameters

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters

Example response

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Response

Status: 500, Internal server error

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/95",
  "title": "Backup not retrieved",
  "detail": "The backup wasn't retrieved because of an internal server issue.",
  "status": "500"
}

Error

Status: 404, Not found

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example error response

{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

additionalDetails

type_astra_stateDetail

Name	Type	Required
type	string	True
title	string	True
detail	string	True
additionalDetails	additionalDetails	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

additionalDetails

False

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

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
labels	array[type_astra_label]	True
creationTimestamp	string	True
modificationTimestamp	string	True
createdBy	string	True
modifiedBy	string	False

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

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

Retrieve an application backup for an app

Creating your file...

Parameters

Response

Response

Response

Response

Response

Error

Definitions