Ein Volumen abrufen
GET /accounts/{account_id}/topology/v1/volumes/{volume_id}
Gibt die gespeicherte Volume-API-Ressource im JSON-Antworttext zurück.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
volume_id |
Zeichenkette |
Pfad |
True |
ID der aufzulistenden Datenträgersammlung |
Antwort
Status: 200, Returns the stored Volume API resource in the JSON 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:
|
Name |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Namen des Volumes. Folgende Werte sind definiert:
|
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:
|
snapshotPossible |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die angibt, ob der Treiber einen Snapshot des Volumes erstellen kann. Folgende Werte sind definiert:
|
storageClass |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die Speicherklasse für das Volume enthält.
|
pvcName |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die den PersistentVolumeClaim (PVC) Namen des Volumes enthält.
|
internalName |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit dem internen Namen des Volumes im Zielspeichercluster, sofern verfügbar. Dieser Name wird vom Kubernetes CSI-Treiber abgerufen.
|
appsUsing |
Array[string] |
True |
JSON-Array von JSON-Zeichenketten, die jeweils die ID einer Anwendung enthalten, die das Volume verwendet. Folgende Werte sind definiert:
|
storageBackendID |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der ID des Speichersystems, das das Volume bereitstellt. Folgende Werte sind definiert:
|
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:
|
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:
|
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:
|
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.
|
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
Beispielantwort
{
"type": "application/astra-volume",
"version": "1.2",
"id": "ab5c9fb8-ddba-526f-8bd3-8d5b72cf4f7f",
"name": "myVolume",
"state": "ready",
"size": "512 GiB",
"used": 10000000000,
"usedPercentage": 10,
"total": 10000000000,
"creationToken": "ba7d4e0c-6ae3-4b6e-859d-9463e7ca4b4e",
"snapshotPossible": "true",
"storageClass": "gold",
"pvcName": "myVolume",
"internalName": "trident_sd234234_23424_897d_876sd65w",
"appsUsing": [],
"orchestrator": "trident",
"serviceLevel": "gold",
"exportPolicy": "astra-vp-default",
"nodeId": "94d16dd2-9beb-4edb-ab58-1a00e9a90052",
"healthState": "normal",
"healthStateDetails": [],
"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
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 |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |