Skip to main content
Astra Automation
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Énumérer les horaires d'une application

PDF

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

Renvoie un tableau JSON contenant toutes les ressources correspondantes de la collection. Si des champs individuels sont spécifiés dans la requête, le tableau JSON items contiendra les champs demandés pour chaque ressource correspondante dans l'ordre indiqué.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

app_id

chaîne

chemin

Vrai

ID de la ressource d'application contenant

inclure

chaîne

requête

Faux

Indique les champs qui doivent être renvoyés lors de l’énumération d’une collection.

Exemples d'URL : « include=id », « include=id,name »

Exemples OpenAPI : « id »

  • Exemple : id, nom, granularité

limite

chaîne

requête

Faux

Indique le nombre maximal de ressources à renvoyer lors de l’énumération d’une collection.

Exemples d'URL : « limit=2 »

Exemples OpenAPI : « 2 »

Réponse

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.
Nom Type Obligatoire Description

articles

tableau[Un des éléments suivants : "schedule_1.3_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "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"
  }
}

Réponse

Status: 401, Unauthorized
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

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

Réponse

Status: 400, Bad request
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux

invalidParams

tableau["invalidParams"]

Faux

Liste des paramètres de requête invalides
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Réponse

Status: 403, Forbidden
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

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

Erreur

Status: 404, Not found
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse d'erreur 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Définitions

Voir les définitions

type_astra_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

type_astra_metadata_update

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

schedule_1.3_get_response_body

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-schedule"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

id

chaîne

Vrai

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

nom

chaîne

Vrai

Chaîne JSON contenant le nom du planning. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

activé

chaîne

Vrai

Chaîne JSON indiquant si une planification est active. Les valeurs définies sont :

  • "true" - Le calendrier est actif

  • « false » - La planification n'est pas active Si elle n'est pas spécifiée, la valeur par défaut est « true ».

granularité

chaîne

Vrai

Chaîne JSON indiquant la granularité de la planification. Les valeurs définies sont :

  • « horaire »

  • "tous les jours"

  • "hebdomadaire"

  • "mensuel"

  • "personnalisé"

minute

chaîne

Vrai

Chaîne JSON contenant une valeur numérique indiquant la minute de l'heure (0 - 59) à laquelle exécuter la planification. Les valeurs définies sont :

  • L'expression régulière définie est : « ^[0-9]

[1-5][0-9]$ ». Ce champ est présent si la granularité est définie sur « hourly », « daily », « weekly » ou « monthly ». Il sera renvoyé avec la valeur « 0 » pour les planifications personnalisées.

heure

chaîne

Faux

Chaîne JSON contenant une valeur numérique indiquant l'heure de la journée (0 - 23) à laquelle exécuter la planification. Les valeurs définies sont :

  • L'expression régulière définie est : "^[0-9]

[1][0-9]

[2][0-3]$" Ce champ est présent si la granularité est définie sur "daily", "weekly" ou "monthly".

dayOfWeek

chaîne

Faux

Chaîne JSON contenant une valeur numérique indiquant le jour de la semaine (0-7) pour exécuter la planification. Les valeurs définies sont :

  • L'expression régulière définie est : "^[0-7]$" Ce champ n'est présent que si la granularité est définie sur "weekly".

dayOfMonth

chaîne

Faux

Chaîne JSON contenant une valeur numérique indiquant le jour du mois (1-31) pour exécuter la planification. Les valeurs définies sont :

  • L'expression régulière définie est : "^[1-9]

[1-2][0-9]

[3][0-1]$" Ce champ n'est présent que si granularité est définie sur "monthly".

recurrenceRule

chaîne

Faux

Chaîne JSON contenant une RFC-5545 section 3.8.5.3. Règle de récurrence. Pour le paramètre DTSTART, seuls les horodatages UTC (indiqués par le suffixe « Z ») sont pris en charge, et seuls les horodatages antérieurs à l'heure actuelle sont pris en charge. Pour les parties de la règle RECUR, « FREQ » et « INTERVAL » sont les seules parties de règle prises en charge. Pour la partie de règle FREQ, « MINUTELY » et « HOURLY » sont les seules valeurs prises en charge. Ce champ est présent uniquement si granularité est définie sur « custom ».

snapshotRetention

chaîne

Vrai

Chaîne JSON contenant une valeur numérique positive indiquant combien d'instantanés conserver. Zéro indique que les instantanés doivent être supprimés après la sauvegarde. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • L'expression régulière définie est : "^(0

([1-9][0-9]*))$"

backupRetention

chaîne

Vrai

Chaîne JSON contenant une valeur numérique positive indiquant combien de sauvegardes doivent être conservées. Zéro indique qu'aucune sauvegarde ne doit être créée. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • L'expression régulière définie est : "^(0

([1-9][0-9]*))$"

ID de compartiment

chaîne

Faux

Chaîne JSON contenant un ID de compartiment optionnel indiquant où la sauvegarde doit être stockée lors de la création. Si non spécifié, un compartiment sélectionné par le système sera utilisé. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

répliquer

chaîne

Faux

Chaîne JSON indiquant si la planification déclenche la réplication AppMirror pour chaque instantané. Ne prend effet que si l'application a une relation AppMirror définie. Les valeurs définies sont :

  • « vrai » - La planification déclenche la réplication AppMirror

  • « false » - La planification ne déclenche pas la réplication AppMirror. Si cette valeur n'est pas spécifiée, la valeur par défaut est « false ».

les métadonnées

type_astra_metadata_list

Nom Type Obligatoire Description

continuer

chaîne

Faux

nombre

nombre

Faux

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

invalidParams

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du paramètre de requête invalide

raison

chaîne

Vrai

Raison pour laquelle le paramètre de requête est invalide