Liste alle Ausführungs-Hooks auf
GET /accounts/{account_id}/core/v1/executionHooks
Gibt ein JSON-Array aller übereinstimmenden Ressourcen in der Sammlung zurück. Wenn in der Anfrage einzelne Felder angegeben werden, enthält das JSON-Array der Elemente die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
Einschließlich |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, welche Felder beim Auflisten einer Sammlung zurückgegeben werden sollen. URL-Beispiele: "include=id", "include=id,name" OpenAPI-Beispiele: "id" |
Grenze |
Zeichenkette |
Abfrage |
Falsch |
Gibt die maximale Anzahl der Ressourcen an, die beim Auflisten einer Sammlung zurückgegeben werden sollen. URL-Beispiele: "limit=2" OpenAPI-Beispiele: "2" |
Filtern |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, welche Felder übereinstimmen müssen, um beim Auflisten einer Sammlung eine Ressource zurückzugeben. Unterstützte Operatoren sind:
URL-Beispiel: "filter=field%20eq%20%27value%27" OpenAPI-Beispiele: "field eq 'value'" |
Antwort
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.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Elemente |
array[Beliebig aus: "executionHook_1.3_get_response_body", array[]] |
Wahr |
|
Metadaten |
Wahr |
Beispielantwort
{
"type": "application/astra-executionHooks",
"version": "1.3",
"items": [
{
"type": "application/astra-executionHook",
"version": "1.1",
"id": "4c64792c-806b-4457-938d-8e325a37c593",
"name": "Payroll",
"hookType": "custom",
"matchingCriteria": [
{
"type": "containerImage",
"value": "payroll"
},
{
"type": "podName",
"value": "^payroll-master"
}
],
"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": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "64182074-ddb6-42eb-b7f4-b6a02cf9ba7c"
}
},
{
"type": "application/astra-executionHook",
"version": "1.1",
"id": "6659892c-c621-44e8-a0bb-8dbdf378a2dd",
"name": "Order Processing",
"hookType": "custom",
"matchingCriteria": [
{
"type": "containerName",
"value": "^order-processing$"
},
{
"type": "podLabel",
"value": "^app=master$|^app=data$"
}
],
"action": "snapshot",
"stage": "pre",
"hookSourceID": "63f4d6fd-b7f0-4eaa-9890-0b11123604b1",
"arguments": [
"freeze"
],
"appID": "7be5ae7c-151d-4230-ac39-ac1d0b33c2a9",
"enabled": "true",
"description": "Order processing hook",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "64182074-ddb6-42eb-b7f4-b6a02cf9ba7c"
}
},
{
"type": "application/astra-executionHook",
"version": "1.1",
"id": "6659892c-c621-44e8-a0bb-8dbdf378a2dd",
"name": "NetApp Postgres Hook",
"hookType": "netapp",
"matchingCriteria": [
{
"type": "podName",
"value": "^postgres"
},
{
"type": "containerImage",
"value": "3.8"
}
],
"action": "snapshot",
"stage": "pre",
"hookSourceID": "3601ed09-1a74-4156-a1bd-9cb7144bac0e",
"arguments": [
"freeze"
],
"enabled": "true",
"description": "Order processing hook",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "64182074-ddb6-42eb-b7f4-b6a02cf9ba7c"
}
},
{
"type": "application/astra-executionHook",
"version": "1.1",
"id": "6659892c-c621-44e8-a0bb-8dbdf378a2dd",
"name": "Redis Hook",
"hookType": "custom",
"matchingCriteria": [
{
"type": "containerName",
"value": "^redis-01$"
}
],
"action": "snapshot",
"stage": "pre",
"hookSourceID": "3601ed09-1a74-4156-a1bd-9cb7144bac0e",
"arguments": [
"freeze"
],
"enabled": "true",
"description": "Order processing hook",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "64182074-ddb6-42eb-b7f4-b6a02cf9ba7c"
}
}
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidParams |
Array["invalidParams"] |
Falsch |
Liste ungültiger Abfrageparameter |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 403, Forbidden
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
matchingCriteria
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die den Typ der Übereinstimmungskriterien identifiziert. |
Wert |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem regulären Ausdruck für den angegebenen Übereinstimmungstyp. Regex-Syntax: https://github.com/google/re2/wiki/Syntax |
type_k8s_label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
matchingContainers
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
podName |
Zeichenkette |
Falsch |
JSON-Zeichenkette des übereinstimmenden Container-Pod-Namens. |
podLabels |
Array["type_k8s_label"] |
Falsch |
JSON-Array von Label-Objekten der Labels des passenden Containers-Pods. |
containerImage |
Zeichenkette |
Falsch |
JSON-Zeichenkette des passenden Container-Images. |
containerName |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit dem Namen des übereinstimmenden Containers. |
namespaceName |
Zeichenkette |
Falsch |
JSON-Zeichenkette des Namespace-Namens des übereinstimmenden Containers-Pods. |
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Falsch |
|
CreationZeitstempel |
Zeichenkette |
Falsch |
|
Änderungszeitstempel |
Zeichenkette |
Falsch |
|
Erstellt von |
Zeichenkette |
Falsch |
|
modifiedBy |
Zeichenkette |
Falsch |
executionHook_1.3_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
Wahr |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem benutzerdefinierten Namen für die Ressource. Definierte Werte sind:
|
hookType |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die den Hook-Typ definiert. Definierte Werte sind:
|
matchingCriteria |
Array["matchingCriteria"] |
Wahr |
JSON-Array von JSON-Objekten, die die Übereinstimmungskriterien für den Ausführungs-Hook beschreiben. Wenn mehrere matchingCriteria angegeben werden, wird eine logische UND-Verknüpfung auf die Kriterien angewendet. Definierte Werte sind:
|
matchingContainers |
Array["matchingContainers"] |
Falsch |
JSON-Array von JSON-Objekten jedes Containers, der den konfigurierten Abgleichskriterien innerhalb der definierten App entspricht. |
matchingImages |
Array[string] |
Falsch |
JSON-Array mit JSON-Strings für die passenden Container-Images. Definierte Werte sind:
|
Aktion |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die angibt, welche Aktion der Ausführungs-Hook ausführt, sofern die Übereinstimmungskriterien erfüllt sind. Definierte Werte sind:
|
Bühne |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die die Phase der Aktion angibt, in der der Hook ausgeführt wird. Definierte Werte sind:
|
hookSourceID |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit der Hook-Quell-ID, die über diesen Ausführungs-Hook ausgeführt wird. Definierte Werte sind:
|
Argumente |
Array[string] |
Falsch |
JSON-Array von JSON-Zeichenketten für die Argumente der Quelle. Definierte Werte sind:
|
App-ID |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der zugehörigen ID der Anwendung, mit der dieser Hook verknüpft ist. Im Wesentlichen weitere festgelegte Übereinstimmungskriterien, falls festgelegt. Definierte Werte sind:
|
aktiviert |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die angibt, ob der Ausführungs-Hook aktiviert ist. Folgende Werte sind definiert:
|
description |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einer benutzerdefinierten Beschreibung der Hook-Quelle. Definierte Werte sind:
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
type_astra_metadata_list
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
fortfahren |
Zeichenkette |
Falsch |
|
Zählen |
Nummer |
Falsch |
|
Etiketten |
Array["Typ_Astra_Label"] |
Falsch |
|
CreationZeitstempel |
Zeichenkette |
Falsch |
|
Änderungszeitstempel |
Zeichenkette |
Falsch |
|
Erstellt von |
Zeichenkette |
Falsch |
|
modifiedBy |
Zeichenkette |
Falsch |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
Wahr |
Grund, warum der Abfrageparameter ungültig ist |