Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Lister toutes les ressources ASUP

PDF

GET /accounts/{account_id}/core/v1/asups

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}}

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 »

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 : "corps de réponse asup_1.0_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-asups",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-asup",
      "version": "1.0",
      "id": "80796606-79ba-480b-966c-e4c600fbf623",
      "creationState": "completed",
      "creationStateDetails": [],
      "upload": "true",
      "uploadState": "running",
      "uploadStateDetails": [],
      "triggerType": "manual",
      "dataWindowStart": "2020-08-05T12:24:00.000000Z",
      "dataWindowEnd": "2020-08-06T12:24:52.000000Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
      }
    },
    {
      "type": "application/astra-asup",
      "version": "1.0",
      "id": "6503131d-8b36-4434-b34f-73661ae8100b",
      "creationState": "completed",
      "creationStateDetails": [],
      "upload": "true",
      "uploadState": "completed",
      "uploadStateDetails": [],
      "triggerType": "scheduled",
      "dataWindowStart": "2020-08-04T13:30:00.000000Z",
      "dataWindowEnd": "2020-08-05T13:30:00.000000Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-05T13:30:00.012321Z",
        "modificationTimestamp": "2020-08-05T13:30:00.012321Z",
        "createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
      }
    }
  ],
  "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

corps de réponse asup_1.0_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-asup"

version

chaîne

Vrai

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

  • "1,0"

id

chaîne

Vrai

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

  • Conforme au schéma UUIDv4

creationState

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état de création du bundle AutoSupport. Pour les états « terminé » et « partiel », le bundle peut être téléchargé en effectuant une requête GET sur l'URI de la ressource avec un en-tête Accept contenant « / » ou « application/gzip ». Les valeurs définies sont :

  • "En cours d'exécution" - AutoSupport bundle la génération s'exécute normalement.

  • "Terminé" - AutoSupport bundle La génération du paquet est terminée.

  • « Partiel » - La génération du bundle AutoSupport est terminée, mais certaines données n'ont pas été incluses dans le bundle.

  • « Échec » - la génération de bundle AutoSupport est dans un état d'échec permanent.

creationStateDetails

tableau["type_astra_stateDetail"]

Vrai

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

  • Nombre minimum d’articles : 0

télécharger

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant s'il faut télécharger le bundle AutoSupport après sa création réussie. Les valeurs définies sont :

  • "true" - Téléverser le AutoSupport bundle.

  • « faux » - Ne téléchargez pas le AutoSupport bundle.

uploadState

chaîne

Faux

Chaîne JSON contenant une valeur indiquant l'état du AutoSupport bundle upload si celui-ci a été demandé. Les valeurs définies sont :

  • "En attente" - le téléchargement du bundle AutoSupport est programmé lorsque la création du bundle AutoSupport est terminée (« creationState » est « running »).

  • "bloqué" - Le téléchargement du bundle AutoSupport n'a pas été tenté car le bundle n'a pas été créé (« creationState » est « échec ») ou le téléchargement a été bloqué faute de licence.

  • "en cours d'exécution" - le chargement du bundle AutoSupport se déroule normalement (« creationState » est « completed » ou « partial »).

  • "Terminé" - AutoSupport bundle upload a été terminé.

  • « Échec » - Le chargement du bundle AutoSupport est dans un état d'échec permanent.

uploadStateDetails

tableau["type_astra_stateDetail"]

Faux

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

  • Nombre minimum d’articles : 0

triggerType

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant ce qui a déclenché la création de la ressource ASUP. Les valeurs définies sont :

  • « manuel » - La ressource ASUP et le bundle AutoSupport associé ont été créés manuellement.

  • « scheduled » - La ressource ASUP et le bundle AutoSupport associé ont été créés selon une planification configurée.

dataWindowStart

chaîne

Vrai

Chaîne JSON contenant un horodatage indiquant l'heure de début de la fenêtre de collecte de données du bundle AutoSupport. Par défaut, cette valeur correspond à 24 heures avant la valeur de la clé « dataWindowEnd ». Elle doit être antérieure à la valeur de la clé « dataWindowEnd ». La durée maximale est de 7 jours avant l'heure actuelle de la requête. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

dataWindowEnd

chaîne

Vrai

Chaîne JSON contenant un horodatage indiquant l'heure de fin de la fenêtre de collecte de données du paquet AutoSupport. Par défaut, il s'agit de l'heure actuelle de la requête. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

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