Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Alle verwalteten Cluster auflisten

Änderungen vorschlagen
PDFs

GET /accounts/{account_id}/topology/v1/managedClusters

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 die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

True

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

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"

  • Beispiel: id,name,managedState

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:

  • eq – Gleichheit

  • lt/gt – Kleiner als/Größer als

  • lte/gte – Kleiner oder gleich/Größer oder gleich

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: "managedCluster_1.2_get_response_body", array[]]

True

Metadaten

"type_astra_metadata_list"

True
Beispielantwort 
{
  "type": "application/astra-managedClusters",
  "version": "1.2",
  "items": [
    [
      "0f284377-e5dc-4dcd-bacd-3197f2b8a347",
      "GKE-21",
      "managed"
    ],
    [
      "04dc80fa-d1d8-4850-a49f-3b70d0ec1369",
      "GKE-22",
      "unmanaged"
    ]
  ],
  "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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

type_astra_stateDetail

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata_update

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra-Metadatenschema. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen 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

managedCluster_1.2_get_response_body

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Folgende Werte sind definiert:

  • "application/astra-managedCluster"

Version

Zeichenkette

True

Version der Ressource. Folgende Werte sind definiert:

  • "1,0"

  • "1,1"

  • "1,2"

id

Zeichenkette

True

Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

True

JSON-Zeichenkette mit einem Namen für den Cluster. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern.

Zustand

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der den Betriebszustand des Clusters angibt. Folgende Werte sind definiert:

  • „pending“ – Das Cluster ist zur Erkennung vorgesehen

  • „discovering“ – Der Cluster befindet sich im Entdeckungsprozess

  • „Bereitstellung“ – Der Cluster wird gerade bereitgestellt

  • "läuft" - Der Cluster läuft normal

  • „Fehlgeschlagen“ – Der Cluster befindet sich in einem permanenten Fehlerzustand

  • „removed“ – Der Cluster ist derzeit nicht erreichbar

  • "unbekannt" – Der Zustand des Clusters kann nicht bestimmt werden

restoreTargetSupported

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der angibt, ob der verwaltete Cluster als Ziel für Anwendungsdatenverwaltungsoperationen geeignet ist. Folgende Werte sind definiert:

  • "true" - Cluster ist ein geeignetes Ziel für App-Datenverwaltungsoperationen.

  • "false" - Cluster ist kein geeignetes Ziel für App-Datenverwaltungsoperationen.

snapshotSupported

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der die Fähigkeit des verwalteten Clusters zur Durchführung von Backup-ähnlichen Operationen für die Anwendungsdatenverwaltung angibt. Folgende Werte sind definiert:

  • "true" – Cluster ist berechtigt, Anwendungsdatenverwaltungsoperationen durchzuführen.

  • "false" - Der Cluster ist nicht berechtigt, Anwendungsdatenverwaltungsoperationen durchzuführen.

stateUnready

Array[string]

True

JSON-Array mit JSON-Strings, die jeweils einen Grund dafür angeben, warum der Cluster nicht in den Status „running“ wechseln kann, wenn im Status „running“ Probleme auftreten oder warum er in den Status „failed“ oder „removed“ gewechselt ist. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 127

managedState

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der den Verwaltungsstatus des Clusters angibt. Folgende Werte sind definiert:

  • „pending“ – Der Cluster ist zur Entdeckung oder zum Hinzufügen geplant

  • „Nicht berechtigt“ – Der Cluster befindet sich im Status „Wird ausgeführt“, wird nicht verwaltet und ist nicht für die Verwaltung berechtigt. Die Gründe für diese Nichtberechtigung sind im Wert des Schlüssels „unready“ angegeben.

  • „Nicht verwaltet“ – Der Cluster befindet sich im Status „Läuft“ oder „Fehlgeschlagen“, wird nicht verwaltet und ist für die Verwaltung geeignet.

  • „Verwaltung“ – Der Cluster befindet sich im Status „Laufend“ und befindet sich im Prozess der Verwaltung.

  • „managed“ – Der Cluster befindet sich im Status „running“, „failed“ oder „removed“ und wird verwaltet.

protectionState

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der den Schutzstatus des Clusters angibt. Folgende Werte sind definiert:

  • „vollständig“ – Die Standard-Speicherklasse des Clusters unterstützt Snapshots

  • "partiell" – Der Cluster verfügt nur über Speicherklassen, die keine Snapshots unterstützen

  • "atRisk" - Die Standard-Speicherklasse des Clusters unterstützt keine Snapshots

protectionStateDetails

Array["type_astra_stateDetail"]

True

JSON-Array mit JSON-Objekten, das zusätzliche Details zum aktuellen Schutzstatus auflistet, einschließlich der Gründe, warum der aktuelle Status erreicht wurde. Sind keine Details verfügbar, ist dieses Array leer. Folgende Werte sind definiert:

  • Mindestanzahl: 0

managedStateUnready

Array[string]

True

JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum der Cluster nicht zur Verwaltung geeignet ist. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 127

managedTimestamp

Zeichenkette

True

JSON-Zeichenkette mit dem Zeitstempel, der angibt, wann der Cluster unter Verwaltung gestellt wurde. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema. Dieser Schlüssel wird nur zurückgegeben, wenn ein Cluster einen managedState von „managed“ hat.

tridentVersion

Zeichenkette

Falsch

JSON-Zeichenkette mit der auf dem Cluster installierten Trident-Version. Folgende Werte sind definiert:

  • Entspricht dem Softwareversionsschema

tridentManagedState

Zeichenkette

Falsch

JSON-Zeichenkette, die einen von mehreren aufgezählten Werten enthält und den Verwaltungsstatus von Trident auf diesem Cluster angibt. Folgende Werte sind definiert:

  • „Verwaltet“ – Trident Instanz im Cluster wird von Astra verwaltet

  • „Unmanaged“ – Trident Instanz im Cluster wird nicht von Astra verwaltet

tridentManagedStateDesired

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der den gewünschten Verwaltungsstatus für Trident angibt. Folgende Werte sind definiert:

  • "Verwaltet" – Trident auf diesem Cluster verwalten

  • „Nicht verwaltet“ – Trident auf diesem Cluster nicht verwalten

tridentManagedStateDetails

Array["type_astra_stateDetail"]

Falsch

JSON-Array mit JSON-Objekten, das zusätzliche Details darüber auflistet, warum „state“ zu „managed“ oder „unmanaged“ gewechselt hat. + Falls keine Details verfügbar sind, ist dieses Array leer.

  • Mindestanzahl: 0

tridentManagedStateAllowed

Array[string]

Falsch

Zustände, die in einem gegebenen tridentManagedState angefordert werden können. Die folgenden Zustände können in jedem definierten Zustand angefordert werden:

  • "verwaltet": "verwaltet"

  • "unmanaged": "unverwaltet"

inUse

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der angibt, ob der Cluster verwaltete Anwendungen enthält und daher nicht gelöscht werden kann. Folgende Werte sind definiert:

  • „falsch“ – Der Cluster wird nicht verwaltet, oder er wird zwar verwaltet, aber es sind keine verwalteten Anwendungen damit verknüpft

  • „true“ – Der Cluster wird verwaltet und hat zugehörige verwaltete Anwendungen.

accHost

Zeichenkette

Falsch

JSON-Zeichenkette, die angibt, dass dieser Cluster die Instanz von Astra Control Center hostet, auf die derzeit zugegriffen wird. Folgende Werte sind definiert:

  • "true" - Dieser Cluster hostet die Instanz des Astra Control Center, die aktuell aufgerufen wird.

clusterType

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der den Clustertyp angibt. Folgende Werte sind definiert:

  • "gke" - Kubernetes, gehostet auf der Google Kubernetes Engine

  • "aks" - Kubernetes, gehostet auf Microsoft Azure Kubernetes Service

  • "eks" - Kubernetes, gehostet auf Amazon Elastic Kubernetes Service

  • "rke" – Der Cluster ist vom Typ Rancher

  • "tanzu" – Der Cluster ist vom Typ Tanzu Kubernetes Grid

  • "openshift" - Der Cluster ist vom Typ OpenShift

  • "kubernetes" - Der Cluster ist ein generisches Kubernetes

clusterVersion

Zeichenkette

True

JSON-Zeichenkette mit der semantischen Versionsdarstellung der Clusterumgebung. Bei Kubernetes-Clustern ist dies die Kubernetes-Version. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

clusterVersionString

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der die erweiterten Versionsinformationen für die Clusterumgebung angibt. Für Kubernetes-Cluster ist dies die vollständige Kubernetes-Version. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

clusterCreationTimestamp

Zeichenkette

Falsch

JSON-Zeichenkette mit dem Zeitstempel, der angibt, wann der Cluster ursprünglich erstellt wurde. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

Namensräume

Array[string]

Falsch

JSON-Array von JSON-Zeichenketten, die jeweils einen Namespace innerhalb des Clusters angeben. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 253

defaultStorageClass

Zeichenkette

Falsch

JSON-Zeichenkette mit einer Speicherklassen-ID, die der in Kubernetes festgelegten Standard-Speicherklasse entspricht. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema. Falls nicht enthalten, wurde es noch nicht entdeckt.

cloudID

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der die ID der Cloud angibt, auf der der Cluster ausgeführt wird. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Anmeldeinformations-ID

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der die ID der Anmeldeinformation angibt, die die kubeconfig-Datei für den Cluster enthält. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Standort

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der von der Cloud bereitgestellt wird, auf der der Cluster ausgeführt wird und den cloudspezifischen Standort des Clusters angibt. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

isMultizonal

Zeichenkette

True

JSON-Zeichenkette mit einem Wert, der von der Cloud bereitgestellt wird, auf der der Cluster ausgeführt wird, und angibt, ob sich der Cluster über zwei oder mehr Verfügbarkeitszonen erstreckt. Folgende Werte sind definiert:

  • "wahr" - Der Cluster erstreckt sich über zwei oder mehr Verfügbarkeitszonen

  • "falsch" - Der Cluster befindet sich vollständig innerhalb einer einzigen Verfügbarkeitszone

privateRouteID

Zeichenkette

Falsch

JSON-Zeichenkette mit der locationID für private Cluster.

  • Mindestlänge: 1

  • Maximale Länge: 255

apiServiceID

Zeichenkette

Falsch

JSON-Zeichenkette mit der UUID des Kubernetes (k8s)-API-Dienstobjekts. Wird zur eindeutigen Identifizierung eines Clusters verwendet.

Metadaten

"type_astra_metadata_update"

True

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra-Metadatenschema. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.

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

True

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

True

Grund, warum der Abfrageparameter ungültig ist