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.

Créer un nouveau hook d'exécution

PDF

POST /accounts/{account_id}/core/v1/executionHooks

Indique les valeurs souhaitées pour la ressource d'API Execution Hook à créer.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

Corps de la requête

Indique les valeurs souhaitées pour la ressource d'API Execution Hook à créer.

Nom Type Obligatoire Description

type

chaîne

Vrai

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

  • "application/astra-executionHook"

version

chaîne

Vrai

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

  • "1,0"

  • "1,1"

  • "1,2"

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 pour toutes les ressources de hook d’exécution.

hookType

chaîne

Vrai

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

  • "netapp" - Hook d'exécution fourni par NetApp.

  • « custom » - lié à un ID d’application spécifique. Les ressources du hook d’exécution avec hookType « netapp » sont en lecture seule.

matchingCriteria

tableau["matchingCriteria"]

Faux

Tableau JSON d'objets JSON décrivant les critères de correspondance pour le hook d'exécution. Lorsque plusieurs matchingCriteria sont spécifiés, un ET logique est appliqué aux critères. Les valeurs définies sont :

  • Nombre minimum d’articles : 0

  • Nombre maximum d'articles : 10

action

chaîne

Vrai

Chaîne JSON indiquant l'action que le hook d'exécution lancera si les critères de correspondance sont remplis. Les valeurs définies sont :

  • "instantané"

  • "sauvegarde"

  • "restaurer"

scène

chaîne

Vrai

Chaîne JSON indiquant l'étape de l'action à laquelle le hook sera exécuté. Les valeurs définies sont :

  • "pre" - Le hook d'exécution sera exécuté avant l'action spécifiée.

  • « post » : le hook d’exécution sera lancé après l’action spécifiée. Les valeurs pour l’action « snapshot » sont « pre » et « post ». Les valeurs pour l’action « backup » sont « pre » et « post ». La valeur pour l’action « restore » est « post ».

hookSourceID

chaîne

Vrai

Chaîne JSON contenant l'identifiant de la source du hook exécuté par ce hook. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

arguments

tableau[chaîne]

Faux

Tableau JSON de chaînes JSON pour les arguments de la source. Les valeurs définies sont :

  • Nombre minimum d’articles : 0

  • Nombre maximum d'articles : 16

  • Longueur minimale : 0

  • Longueur maximale : 127

ID de l'application

chaîne

Vrai

Chaîne JSON contenant l'identifiant associé de l'application à laquelle ce hook est lié. En essence, d'autres critères de correspondance, si définis. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

activé

chaîne

Faux

Chaîne JSON indiquant si le hook d'exécution est activé. Les valeurs définies sont :

  • "true" - Le hook d'exécution est activé et sera exécuté comme spécifié.

  • « false » - Le hook d’exécution est désactivé et ne sera jamais exécuté. La valeur par défaut est « true ».

description

chaîne

Faux

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

  • Longueur minimale : 0

  • Longueur maximale : 511

les métadonnées

"type_astra_metadata_update"

Faux

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 requête 
{
  "type": "application/astra-executionHook",
  "version": "1.2",
  "name": "Payroll",
  "hookType": "custom",
  "action": "snapshot",
  "stage": "pre",
  "hookSourceID": "50e89023-ba84-435d-bb47-1833f4c250ff",
  "arguments": [
    "freeze"
  ],
  "appID": "7be5ae7c-151d-4230-ac39-ac1d0b33c2a9",
  "enabled": "true",
  "description": "Payroll production hook"
}

Réponse

Status: 201, Returns the newly created executionHook 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-executionHook"

version

chaîne

Vrai

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

  • "1,0"

  • "1,1"

  • "1,2"

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 pour toutes les ressources de hook d’exécution.

hookType

chaîne

Vrai

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

  • "netapp" - Hook d'exécution fourni par NetApp.

  • « custom » - lié à un ID d’application spécifique. Les ressources du hook d’exécution avec hookType « netapp » sont en lecture seule.

matchingCriteria

tableau["matchingCriteria"]

Vrai

Tableau JSON d'objets JSON décrivant les critères de correspondance pour le hook d'exécution. Lorsque plusieurs matchingCriteria sont spécifiés, un ET logique est appliqué aux critères. Les valeurs définies sont :

  • Nombre minimum d’articles : 0

  • Nombre maximum d'articles : 10

matchingContainers

tableau["matchingContainers"]

Faux

Tableau JSON d'objets JSON pour chaque conteneur correspondant aux critères de correspondance configurés au sein de l'application définie.

matchingImages

tableau[chaîne]

Faux

Tableau JSON de chaînes JSON pour les images conteneurs correspondantes. Les valeurs définies sont :

  • Nombre minimum d’articles : 0

  • Nombre maximum d'articles : 4095

  • Longueur minimale : 1

  • Longueur maximale : 255

action

chaîne

Vrai

Chaîne JSON indiquant l'action que le hook d'exécution lancera si les critères de correspondance sont remplis. Les valeurs définies sont :

  • "instantané"

  • "sauvegarde"

  • "restaurer"

scène

chaîne

Vrai

Chaîne JSON indiquant l'étape de l'action à laquelle le hook sera exécuté. Les valeurs définies sont :

  • "pre" - Le hook d'exécution sera exécuté avant l'action spécifiée.

  • « post » : le hook d’exécution sera lancé après l’action spécifiée. Les valeurs pour l’action « snapshot » sont « pre » et « post ». Les valeurs pour l’action « backup » sont « pre » et « post ». La valeur pour l’action « restore » est « post ».

hookSourceID

chaîne

Vrai

Chaîne JSON contenant l'identifiant de la source du hook exécuté par ce hook. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

arguments

tableau[chaîne]

Faux

Tableau JSON de chaînes JSON pour les arguments de la source. Les valeurs définies sont :

  • Nombre minimum d’articles : 0

  • Nombre maximum d'articles : 16

  • Longueur minimale : 0

  • Longueur maximale : 127

ID de l'application

chaîne

Faux

Chaîne JSON contenant l'identifiant associé de l'application à laquelle ce hook est lié. En essence, d'autres critères de correspondance, si définis. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

activé

chaîne

Vrai

Chaîne JSON indiquant si le hook d'exécution est activé. Les valeurs définies sont :

  • "true" - Le hook d'exécution est activé et sera exécuté comme spécifié.

  • « false » - Le hook d’exécution est désactivé et ne sera jamais exécuté. La valeur par défaut est « true ».

description

chaîne

Faux

Chaîne JSON contenant une description, spécifiée par l'utilisateur, de la source du hook. 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-executionHook",
  "version": "1.2",
  "id": "946e60cb-980b-5374-9e6e-9fe1f6780352",
  "name": "Payroll",
  "hookType": "custom",
  "matchingCriteria": [],
  "action": "snapshot",
  "stage": "pre",
  "hookSourceID": "50e89023-ba84-435d-bb47-1833f4c250ff",
  "arguments": [
    "freeze"
  ],
  "appID": "7be5ae7c-151d-4230-ac39-ac1d0b33c2a9",
  "enabled": "true",
  "description": "Payroll production hook",
  "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

invalidFields

tableau["invalidFields"]

Faux

Liste des champs invalides du corps de la requête
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: 409, Conflict
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/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

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

matchingCriteria

Nom Type Obligatoire Description

type

chaîne

Faux

Chaîne JSON identifiant le type de critères de correspondance.

valeur

chaîne

Faux

Chaîne JSON contenant une expression régulière permettant de rechercher le type de correspondance spécifié. Syntaxe de l'expression régulière : https://github.com/google/re2/wiki/Syntax

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

matchingCriteria

Nom Type Obligatoire Description

type

chaîne

Vrai

Chaîne JSON identifiant le type de critères de correspondance.

valeur

chaîne

Vrai

Chaîne JSON contenant une expression régulière permettant de rechercher le type de correspondance spécifié. Syntaxe de l'expression régulière : https://github.com/google/re2/wiki/Syntax

type_k8s_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

matchingContainers

Nom Type Obligatoire Description

podName

chaîne

Faux

Chaîne JSON du nom du pod correspondant au conteneur.

podLabels

tableau["type_k8s_label"]

Faux

Tableau JSON d'objets d'étiquette correspondant aux étiquettes du pod du conteneur correspondant.

containerImage

chaîne

Faux

Chaîne JSON de l'image du conteneur correspondant.

containerName

chaîne

Faux

Chaîne JSON du nom du conteneur correspondant.

namespaceName

chaîne

Faux

Chaîne JSON correspondant au nom de l'espace de noms du pod du conteneur.

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

invalidFields

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du champ invalide du corps de la requête

raison

chaîne

Vrai

Raison pour laquelle le champ du corps de la requête est invalide