Alle Speicher-Backends auflisten
GET /accounts/{account_id}/topology/v1/storageBackends
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
|
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" |
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: "storageBackend_1.3_get_response_body", array[]] |
True |
|
Metadaten |
True |
Beispielantwort
{
"type": "application/astra-storageBackends",
"version": "1.3",
"items": [
[
"d6ee1e51-d65f-415a-a3d4-6d7fa8b64943",
"st1-45",
"running"
],
[
"a5c508b7-aacd-4d19-9455-53c0d183ab4e",
"st2-67",
"discovered"
]
],
"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
Fähigkeiten
JSON-Objekt, das die Funktionen dieses Storage Backend enthält.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
FlexClone |
Zeichenkette |
True |
JSON-Zeichenkette, die angibt, ob dieses Storage Backend FlexClone unterstützt. |
snapMirror |
Zeichenkette |
True |
JSON-Zeichenkette, die angibt, ob dieses Storage Backend SnapMirror unterstützt. |
s3 |
Zeichenkette |
True |
JSON-Zeichenkette, die angibt, ob dieses Storage Backend S3 unterstützt. |
ONTAP
JSON-Objekt mit spezifischen Informationen zu ONTAP Clustern.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
authenticationStyle |
Zeichenkette |
True |
JSON-Zeichenkette, die angibt, ob die ONTAP Authentifizierung mittels Benutzername/Passwort-Kombination oder Zertifikat erfolgt. Folgende Werte sind definiert:
|
backendManagementIP |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die IP-Adresse enthält, die zur Verbindung mit diesem ONTAP Cluster verwendet wird. |
Management-IPs |
Array[string] |
Falsch |
Ein JSON-Array mit JSON-Strings, das die Liste aller möglichen Management-IPs enthält, die zur Verbindung mit diesem ONTAP Cluster verwendet werden. Dies wird verwendet, um Backends, die über Trident erkannt wurden, mit Speicher-Backends in Astra zu korrelieren.
|
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 |
storageBackend_1.3_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Folgende Werte sind definiert:
|
Version |
Zeichenkette |
True |
Version der Ressource. Folgende Werte sind definiert:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:
|
backendName |
Zeichenkette |
True |
JSON-Zeichenkette mit einem benutzerdefinierten Namen für das Storage-Backend. Folgende Werte sind definiert:
|
backendType |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Typ des dargestellten Speichersystems angibt. Folgende Werte sind definiert:
|
backendVersion |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der die Version des dargestellten Storage-Backends angibt. Folgende Werte sind definiert:
|
backendCredentialsName |
Zeichenkette |
True |
JSON-Zeichenfolge mit einem Wert, der den Namen einer oder mehrerer für das Speicher-Backend verwendeter Anmeldeinformationsressourcen angibt. Ermöglicht die Rotation von Anmeldeinformationen, wenn mehrere Anmeldeinformationsobjekte denselben Namen haben. Folgende Werte sind definiert:
|
configVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der die vom Storage-Backend zu verwendende aktive Konfiguration angibt. Folgende Werte sind definiert:
|
Zustand |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Betriebszustand des Storage-Backends angibt. Folgende Werte sind definiert:
|
stateDesired |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der den gewünschten Betriebszustand des Storage-Backends angibt. Folgende Werte sind definiert:
|
stateUnready |
Array[string] |
True |
JSON-Array von JSON-Strings, die jeweils einen Grund dafür angeben, warum ein Speichersystem nicht in den Status „running“ wechseln kann, warum es in den Status „failed“ oder „unknown“ gewechselt ist und/oder warum ein Wechsel in den Status „failed“ droht. Folgende Werte sind definiert:
|
managedState |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Verwaltungsstatus des Storage-Backends angibt. Folgende Werte sind definiert:
|
managedStateUnready |
Array[string] |
True |
JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum das Storage-Backend nicht verwaltet werden kann. Folgende Werte sind definiert:
|
healthState |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der den Integritätsstatus des Storage-Backends angibt. Folgende Werte sind definiert:
|
healthStateUnready |
Array[string] |
Falsch |
JSON-Array von JSON-Strings, die jeweils einen Grund dafür angeben, warum sich ein Storage-Backend nicht in einem normalen Gesundheitszustand befindet. Folgende Werte sind definiert:
|
protectionState |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Schutzstatus des Storage-Backends angibt. „unknown“ für ONTAP. Folgende Werte sind definiert:
|
protectionStateUnready |
Array[string] |
True |
JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum eine Datensicherungsstrategie nicht den Vorgaben entspricht. Folgende Werte sind definiert:
|
Fähigkeiten |
True |
JSON-Objekt, das die Funktionen dieses Storage Backend enthält. |
|
ONTAP |
Falsch |
JSON-Objekt mit spezifischen Informationen zu ONTAP Clustern.
|
|
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
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 |