List the schedules for an app

10/23/2024 Contributors

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/schedules

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

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
include	string	query	False	Indicates which fields should be returned when listing a collection. URL examples: "include=id", "include=id,name" OpenAPI examples: "id" example: id,name,granularity
limit	string	query	False	Indicates the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2"

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

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

example: id,name,granularity

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Name	Type	Required	Description
items	array[Any of: schedule_1.3_get_response_body, array[]]	True
metadata	type_astra_metadata_list	True

Name

Type

Required

Description

items

array[Any of: schedule_1.3_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True

Example response

{
  "type": "application/astra-schedules",
  "version": "1.3",
  "items": [
    [
      "0d6d20d6-8b7c-498a-b57b-5734210c209a",
      "Backup Schedule",
      "monthly"
    ]
  ],
  "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"
}

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

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_update

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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name	Type	Required
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

schedule_1.3_get_response_body

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-schedule"
version	string	True	Version of the resource. Defined values are: "1.0" "1.1" "1.2" "1.3"
id	string	True	Globally unique identifier of the resource. Defined values are: Conforms to the UUIDv4 Schema
name	string	True	JSON string containing a name of the schedule. Defined values are: Minimum length: 1 Maximum length: 63
enabled	string	True	JSON string indicating if a schedule is active. Defined values are: "true" - The schedule is active "false" - The schedule is not active If not specified, the default value is "true".
granularity	string	True	JSON string indicating the granularity of the schedule. Defined values are: "hourly" "daily" "weekly" "monthly" "custom"
minute	string	True	JSON string containing a numeric value indicating the minute of the hour (0 - 59) to execute the schedule. Defined values are: Defined regex is: "^[0-9]\|[1-5][0-9]$" This field is present if granularity is set to "hourly", "daily", "weekly", or "monthly". It will be returned with value "0" for custom schedules.
hour	string	False	JSON string containing a numeric value indicating the hour of the day (0 - 23) to execute the schedule. Defined values are: Defined regex is: "^[0-9]\|[1][0-9]\|[2][0-3]$" This field is present if granularity is set to "daily", "weekly", or "monthly".
dayOfWeek	string	False	JSON string containing a numeric value indicating the day of the week (0-7) to execute the schedule. Defined values are: Defined regex is: "^[0-7]$" This field is only present if granularity is set to "weekly".
dayOfMonth	string	False	JSON string containing a numeric value indicating the day of the month (1-31) to execute the schedule. Defined values are: Defined regex is: "^[1-9]\|[1-2][0-9]\|[3][0-1]$" This field is only present if granularity is set to "monthly".
recurrenceRule	string	False	JSON string containing an RFC-5545 Section 3.8.5.3. Recurrence Rule. For the DTSTART parameter, only UTC timestamps (denoted by the "Z" suffix) are supported, and only timestamps before the current time are supported. For the RECUR rule parts, "FREQ" and "INTERVAL" are the only rule parts supported. For the FREQ rule part, "MINUTELY" and "HOURLY" are the only values supported. This field is only present if granularity is set to "custom".
snapshotRetention	string	True	JSON string containing a positive numeric value indicating how many snapshots to retain. Zero indicates that snapshots should be deleted after taking a backup. Defined values are: Minimum length: 1 Maximum length: 63 Defined regex is: "^(0\|([1-9][0-9]*))$"
backupRetention	string	True	JSON string containing a positive numeric value indicating how many backups to retain. Zero indicates that no backups should be created. Defined values are: Minimum length: 1 Maximum length: 63 Defined regex is: "^(0\|([1-9][0-9]*))$"
bucketID	string	False	JSON string containing an optional bucket ID indicating where the backup must be stored on create. If not specified, a system-selected bucket will be used. Defined values are: Conforms to the Astra Identifier Schema
replicate	string	False	JSON string indicating if the schedule triggers AppMirror replication for each snapshot. Only takes effect if the application has an AppMirror relationship defined. Defined values are: "true" - The schedule triggers AppMirror replication "false" - The schedule does not trigger AppMirror replication If not specified, the default value is "false".
metadata	type_astra_metadata_update	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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name

Type

Required

Description

type

string

True

Media type of the resource. Defined values are:

"application/astra-schedule"

version

string

True

Version of the resource. Defined values are:

"1.0"
"1.1"
"1.2"
"1.3"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a name of the schedule. Defined values are:

Minimum length: 1
Maximum length: 63

enabled

string

True

JSON string indicating if a schedule is active. Defined values are:

"true" - The schedule is active
"false" - The schedule is not active If not specified, the default value is "true".

granularity

string

True

JSON string indicating the granularity of the schedule. Defined values are:

"hourly"
"daily"
"weekly"
"monthly"
"custom"

minute

string

True

JSON string containing a numeric value indicating the minute of the hour (0 - 59) to execute the schedule. Defined values are:

Defined regex is: "^[0-9]|[1-5][0-9]$" This field is present if granularity is set to "hourly", "daily", "weekly", or "monthly". It will be returned with value "0" for custom schedules.

hour

string

False

JSON string containing a numeric value indicating the hour of the day (0 - 23) to execute the schedule. Defined values are:

Defined regex is: "^[0-9]|[1][0-9]|[2][0-3]$" This field is present if granularity is set to "daily", "weekly", or "monthly".

dayOfWeek

string

False

JSON string containing a numeric value indicating the day of the week (0-7) to execute the schedule. Defined values are:

Defined regex is: "^[0-7]$" This field is only present if granularity is set to "weekly".

dayOfMonth

string

False

JSON string containing a numeric value indicating the day of the month (1-31) to execute the schedule. Defined values are:

Defined regex is: "^[1-9]|[1-2][0-9]|[3][0-1]$" This field is only present if granularity is set to "monthly".

recurrenceRule

string

False

JSON string containing an RFC-5545 Section 3.8.5.3. Recurrence Rule. For the DTSTART parameter, only UTC timestamps (denoted by the "Z" suffix) are supported, and only timestamps before the current time are supported. For the RECUR rule parts, "FREQ" and "INTERVAL" are the only rule parts supported. For the FREQ rule part, "MINUTELY" and "HOURLY" are the only values supported. This field is only present if granularity is set to "custom".

snapshotRetention

string

True

JSON string containing a positive numeric value indicating how many snapshots to retain. Zero indicates that snapshots should be deleted after taking a backup. Defined values are:

Minimum length: 1
Maximum length: 63
Defined regex is: "^(0|([1-9][0-9]*))$"

backupRetention

string

True

JSON string containing a positive numeric value indicating how many backups to retain. Zero indicates that no backups should be created. Defined values are:

Minimum length: 1
Maximum length: 63
Defined regex is: "^(0|([1-9][0-9]*))$"

bucketID

string

False

JSON string containing an optional bucket ID indicating where the backup must be stored on create. If not specified, a system-selected bucket will be used. Defined values are:

Conforms to the Astra Identifier Schema

replicate

string

False

JSON string indicating if the schedule triggers AppMirror replication for each snapshot. Only takes effect if the application has an AppMirror relationship defined. Defined values are:

"true" - The schedule triggers AppMirror replication
"false" - The schedule does not trigger AppMirror replication If not specified, the default value is "false".

metadata

type_astra_metadata_update

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. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

type_astra_metadata_list

Name	Type	Required
continue	string	False
count	number	False
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

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

List the schedules for an app

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions