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.

Récupérer une source de hook

PDF

GET /accounts/{account_id}/core/v1/hookSources/{hookSource_id}

Renvoie la ressource API Hook Source stockée dans le corps de la réponse JSON.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

hookSource_id

chaîne

chemin

Vrai

ID de la collection hookSource à lister

Réponse

Status: 200, Returns the stored Hook Source API resource in the JSON response body.
Nom Type Obligatoire Description

type

chaîne

Vrai

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

  • "application/astra-hookSource"

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

nom

chaîne

Vrai

Chaîne JSON contenant un nom spécifié par l'utilisateur pour la ressource. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63 Le nom doit être unique parmi toutes les ressources sources du hook.

privé

chaîne

Vrai

Chaîne JSON indiquant si le champ source sera exposé dans les API ou restera intentionnellement vide. Les valeurs possibles sont :

  • « true » - La valeur source est privée et ne sera pas exposée via l'API.

  • "false" - La valeur source n'est pas privée et sera exposée via l'API.

préchargé

chaîne

Vrai

Chaîne JSON indiquant si la source a été préchargée. Les valeurs possibles sont :

  • "true" - La source a été préchargée.

  • « false » : la source n’a pas été préchargée. Les ressources sources des hooks préchargées sont en lecture seule.

sourceType

chaîne

Vrai

Chaîne JSON définissant le type de source du hook. Les valeurs définies sont :

  • « script » - Script shell. Le code source en texte brut ne doit pas contenir de données binaires ni de caractères de retour chariot, sous peine de générer une erreur.

source

chaîne

Faux

Chaîne JSON contenant le script à exécuter au format base64. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 131072

  • Conforme au schéma de données encodées en base64 La taille maximale d'une valeur source est de 128 KiB lorsqu'elle est encodée en base64.

sourceMD5Checksum

chaîne

Vrai

Chaîne JSON contenant la somme de contrôle MD5 calculée pour la valeur de la clé « source ». Les valeurs définies sont :

  • L'expression régulière définie est : "^([0-9a-fA-F]){32}$"

description

chaîne

Faux

Chaîne JSON contenant une description de la source du hook spécifiée par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 511

les métadonnées

"type_astra_metadata_update"

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. 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.
Exemple de réponse 
{
  "type": "application/astra-hookSource",
  "version": "1.0",
  "id": "fae6dfbb-ecb8-58ff-a116-6357eb7c956a",
  "name": "Payroll script",
  "private": "false",
  "preloaded": "false",
  "sourceType": "script",
  "source": "ZWNobyAiVkhKaGJuTWdVbWxuYUhSeklRPT0iIHwgYmFzZTY0IC1k",
  "sourceMD5Checksum": "b1a4b8b0144c3f6be553b626130ca145",
  "description": "Pre and post hook script for payroll",
  "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

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