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 Volumes auflisten

Änderungen vorschlagen
PDFs

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

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

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"

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

True

Metadaten

"type_astra_metadata_list"

True
Beispielantwort 
{
  "type": "application/astra-volumes",
  "version": "1.2",
  "items": [
    [
      "24fe6e79-bf8d-45c9-96af-ef1d11fbd4a0",
      "myVolume"
    ],
    [
      "20a370f4-957f-446a-9126-08853d01933a",
      "secondVol"
    ],
    [
      "48e349a2-5bcd-4c59-896c-12b8240e634b",
      "smallVol"
    ]
  ],
  "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

additionalDetails

type_astra_stateDetail

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

additionalDetails

"additionalDetails"

Falsch

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata

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

  • Entspricht dem Astra Metadatenschema

Name Typ Erforderlich Beschreibung

Etiketten

Array["Typ_Astra_Label"]

True

CreationZeitstempel

Zeichenkette

True

Änderungszeitstempel

Zeichenkette

True

Erstellt von

Zeichenkette

True

modifiedBy

Zeichenkette

Falsch

volume_1.2_get_response_body

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Folgende Werte sind definiert:

  • "application/astra-volume"

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 dem Namen des Volumes. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 255

Zustand

Zeichenkette

Falsch

JSON-Zeichenkette, die einen Wert enthält, der den Betriebszustand des Volumes angibt.

Größe

Zeichenkette

Falsch

JSON-Zeichenkette, die die Größe des Volumens enthält.

verwendet

Nummer

Falsch

JSON-Zahl, die die Anzahl der vom bereitgestellten Volume verwendeten Kontingentbytes enthält.

usedPercentage

Nummer

Falsch

JSON-Zahl, die den Prozentsatz des genutzten Volumens enthält.

gesamt

Nummer

Falsch

JSON-Zahl mit der Gesamtbytezahl der bereitgestellten Volumes.

creationToken

Zeichenkette

Falsch

JSON-Zeichenkette mit dem Erstellungstoken des Volumes. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 255

snapshotPossible

Zeichenkette

Falsch

JSON-Zeichenkette, die angibt, ob der Treiber einen Snapshot des Volumes erstellen kann. Folgende Werte sind definiert:

  • "true" - Der Treiber kann eine Momentaufnahme des Volumens erstellen.

  • "false" - Der Treiber kann keinen Snapshot des Volumes erstellen

storageClass

Zeichenkette

Falsch

JSON-Zeichenkette, die die Speicherklasse für das Volume enthält.

  • Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 255

pvcName

Zeichenkette

Falsch

JSON-Zeichenkette, die den PersistentVolumeClaim (PVC) Namen des Volumes enthält.

  • Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 255

internalName

Zeichenkette

Falsch

JSON-Zeichenkette mit dem internen Namen des Volumes im Zielspeichercluster, sofern verfügbar. Dieser Name wird vom Kubernetes CSI-Treiber abgerufen.

  • Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 255

appsUsing

Array[string]

True

JSON-Array von JSON-Zeichenketten, die jeweils die ID einer Anwendung enthalten, die das Volume verwendet. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

storageBackendID

Zeichenkette

Falsch

JSON-Zeichenkette mit der ID des Speichersystems, das das Volume bereitstellt. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Orchestrator

Zeichenkette

Falsch

JSON-Zeichenfolge mit dem Orchestrator für dieses Volume. Dies wird für Astra Data Store Volumes definiert. Folgende Werte sind definiert:

  • "trident" – Trident hat dieses Volume bereitgestellt

  • "vasa" - NetApp VASA Provider hat dieses Volume bereitgestellt

  • „other“ – Das Volume wurde manuell bereitgestellt oder der Orchestrator ist unbekannt

serviceLevel

Zeichenkette

Falsch

JSON-Zeichenkette mit der auf Storage-Backend-Ebene für dieses Volume definierten Quality of Service (QoS)-Richtlinie. Dies wird für Astra Data Store Volumes definiert.

exportPolicy

Zeichenkette

Falsch

JSON-Zeichenfolge mit der Exportrichtlinie für dieses Volume. Dies wird für Astra Data Store Volumes definiert.

nodeId

Zeichenkette

Falsch

JSON-Zeichenfolge mit der Knoten-ID, die das Volume bedient. Dies wird für Astra Data Store Volumes definiert. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

healthState

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der den Integritätsstatus des Volumes angibt. Dies wird für Astra Data Store Volumes definiert. Folgende Werte sind definiert:

  • „unbestimmt“ – Der Zustand der Ressource kann nicht bestimmt werden (z. B. aufgrund fehlender Verbindung)

  • „normal“ – Die Ressource weist keine bekannten Probleme auf und kann Dienste gemäß der Schnittstellenspezifikation bereitstellen.

  • "Warnung" – Die Ressource weist bekannte Probleme auf, die sie jedoch nicht daran hindern, Dienste gemäß der Schnittstellenspezifikation bereitzustellen.

  • "kritisch" – Die Ressource weist bekannte Probleme auf, die sie daran hindern, Dienste gemäß der Schnittstellenspezifikation bereitzustellen.

healthStateDetails

Array["type_astra_stateDetail"]

True

Ein JSON-Array mit JSON-Objekten, das zusätzliche Details zum aktuellen Zustand auflistet. Sind keine Details verfügbar, ist dieses Array leer.

  • Mindestanzahl: 0

Metadaten

"type_astra_metadata"

True

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

  • Entspricht dem Astra Metadatenschema

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