Ein Speicher-Backend abrufen
GET /accounts/{account_id}/topology/v1/storageBackends/{storageBackend_id}
Gibt die gespeicherte Storage Backend API-Ressource im JSON-Antworttext zurück.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
storageBackend_id |
Zeichenkette |
Pfad |
Wahr |
ID der storageBackend Sammlung, die aufgelistet werden soll |
Antwort
Status: 200, Returns the stored Storage Backend API resource in the JSON 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:
|
backendName |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem benutzerdefinierten Namen für das Storage-Backend. Definierte Werte sind:
|
backendType |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Typ des dargestellten Speichersystems angibt. Folgende Werte sind definiert:
|
backendVersion |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der die Version des verwendeten Storage-Backends angibt. Folgende Werte sind definiert:
|
backendCredentialsName |
Zeichenkette |
Wahr |
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. Definierte Werte sind:
|
configVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der die vom Speichersystem zu verwendende aktive Konfiguration angibt. Folgende Werte sind definiert:
|
Zustand |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Betriebszustand des Storage-Backends angibt. Definierte Werte sind:
|
stateDesired |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der den gewünschten Betriebszustand des Storage-Backends angibt. Definierte Werte sind:
|
stateUnready |
Array[string] |
Wahr |
JSON-Array von JSON-Strings, die jeweils einen Grund dafür angeben, warum ein Storage-Backend 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. Definierte Werte sind:
|
managedState |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Verwaltungsstatus des Storage-Backends angibt. Definierte Werte sind:
|
managedStateUnready |
Array[string] |
Wahr |
JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum das Storage-Backend nicht verwaltet werden kann. Definierte Werte sind:
|
healthState |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der den Integritätsstatus des Speichersystems 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. Definierte Werte sind:
|
protectionState |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Schutzstatus des Storage-Backends angibt. „unknown“ für ONTAP. Definierte Werte sind:
|
protectionStateUnready |
Array[string] |
Wahr |
JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum eine Datensicherungsstrategie nicht den Vorgaben entspricht. Definierte Werte sind:
|
Fähigkeiten |
Wahr |
JSON-Objekt, das die Funktionen dieses Storage Backend enthält. |
|
ONTAP |
Falsch |
JSON-Objekt mit spezifischen Informationen zu ONTAP Clustern.
|
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-storageBackend",
"version": "1.3",
"id": "04ad4237-3c89-5ca5-8a40-282ab5eb6428",
"backendName": "st1-45",
"backendType": "ontap",
"backendVersion": "9.8",
"backendCredentialsName": "st1-45-cred",
"state": "discovered",
"stateUnready": [],
"managedState": "unmanaged",
"managedStateUnready": [],
"protectionState": "unknown",
"protectionStateUnready": [
"Waiting for storage backend discovery"
],
"capabilities": {
"flexClone": "true",
"snapMirror": "true",
"s3": "true"
},
"ontap": {
"authenticationStyle": "basic",
"backendManagementIP": "10.193.179.105",
"managementIPs": [
"10.193.188.110",
"10.193.179.105",
"10.193.179.106"
]
},
"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
Fähigkeiten
JSON-Objekt, das die Funktionen dieses Storage Backend enthält.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
FlexClone |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die angibt, ob dieses Storage Backend FlexClone unterstützt. |
SnapMirror |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die angibt, ob dieses Storage Backend SnapMirror unterstützt. |
s3 |
Zeichenkette |
Wahr |
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 |
Wahr |
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 |
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 |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
Wahr |
Grund, warum der Abfrageparameter ungültig ist |