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.

Lister les instantanés d’application pour une application

PDF

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

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,name,state

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[N'importe lequel de : "appSnap_1.3_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-appSnaps",
  "version": "1.3",
  "items": [
    [
      "2b6dafc3-2172-4431-a482-6306b2703130",
      "app-name-245",
      "pending"
    ],
    [
      "6fd9b31a-3924-4c9a-878b-175fa9538b8c",
      "app-name-244",
      "completed"
    ]
  ],
  "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

additionalDetails

type_astra_stateDetail

Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

additionalDetails

"additionalDetails"

Faux

type_astra_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

type_astra_metadata

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.

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Vrai

CréationTimestamp

chaîne

Vrai

ModificationTimestamp

chaîne

Vrai

CreatedBy

chaîne

Vrai

modifiedBy

chaîne

Faux

appSnap_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-appSnap"

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 un nom défini par l'utilisateur pour l'instantané. Si aucun nom n'est spécifié, ou lorsque les instantanés sont déclenchés par une planification, le système attribue un nom à l'instantané. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Conforme au schéma d'étiquette DNS 1123

ID de compartiment

chaîne

Faux

Chaîne JSON contenant un ID de compartiment optionnel indiquant l'emplacement de stockage de l'instantané lors de sa création. Si cet ID n'est pas spécifié, le compartiment par défaut du cluster est utilisé. Si aucun compartiment par défaut n'est spécifié sur le cluster, le compartiment par défaut du cloud correspondant est utilisé. Si le compartiment par défaut du cloud n'est pas disponible, une erreur est renvoyée lors de la création. Valeurs définies :

  • Conforme au schéma d'identifiant Astra

ID de planification

chaîne

Faux

Chaîne JSON contenant un ID de planification facultatif indiquant que l'instantané a été déclenché par une planification et précisant quelle planification a déclenché l'instantané. Présent uniquement pour les instantanés déclenchés par une planification. Valeurs définies :

  • Conforme au schéma d'identifiant Astra

snapshotAppAsset

chaîne

Faux

Chaîne JSON contenant l'identifiant de la ressource d'application correspondant à l'instantané. Ce champ sera renvoyé lorsque l'état de l'instantané de l'application est « completed ». Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

État

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état opérationnel de l'instantané. Les valeurs définies sont :

  • « En attente » - L’instantané de l’application est programmé pour être découvert

  • « discovering » - L'instantané de l'application est en cours de découverte

  • « running » - L’instantané de l’application fonctionne normalement

  • « completed » - L'instantané de l'application est terminé

  • « Échec » - L’instantané de l’application est dans un état d’échec permanent

  • « Supprimé » - L'instantané de l'application n'est actuellement pas accessible

  • « deleting » - L'instantané de l'application est en cours de suppression

  • « unknown » - L'état de l'instantané de l'application ne peut être déterminé

stateUnready

tableau[chaîne]

Vrai

Tableau JSON de chaînes JSON, chacune indiquant la raison pour laquelle un instantané d'application ne peut pas passer à l'état « en cours d'exécution » ou pourquoi il est passé à l'état « en échec ». Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 127

stateDetails

tableau["type_astra_stateDetail"]

Faux

Tableau JSON d'objets JSON répertoriant des détails supplémentaires sur l'état actuel, notamment la raison pour laquelle cet état a été atteint. Si aucun détail n'est disponible, ce tableau sera vide. Valeurs définies :

  • Nombre minimum d'articles : 0

hookState

chaîne

Faux

Chaîne JSON contenant une valeur indiquant l'état d'un ou plusieurs hooks d'exécution exécutés dans le cadre d'un instantané. Les valeurs définies sont :

  • « failed » - Un ou plusieurs hooks d'exécution ont échoué

  • « succès » - Il y avait zéro ou plusieurs crochets applicables et tous ont réussi

hookStateDetails

tableau["type_astra_stateDetail"]

Faux

Tableau JSON d'objets JSON contenant des détails supplémentaires sur la raison pour laquelle «hookState» est passé à «failed». Si aucun détail n'est disponible, ce tableau sera vide.

  • Nombre minimum d’articles : 0

les métadonnées

"type_astra_metadata"

Vrai

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.

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