Elenca tutti i volumi
GET /accounts/{account_id}/topology/v1/volumes
Restituisce un array JSON di tutte le risorse corrispondenti nella raccolta. Se nella richiesta vengono specificati singoli campi, l'array JSON degli elementi conterrà i campi richiesti per ciascuna risorsa corrispondente nell'ordine specificato.
Parametri
| Nome | Tipo | In | Obbligatorio | Descrizione |
|---|---|---|---|---|
ID account |
stringa |
percorso |
Vero |
ID della risorsa account contenitore
|
includi |
stringa |
query |
Falso |
Indica quali campi devono essere restituiti durante l'elenco di una raccolta. Esempi di URL: "include=id", "include=id,name" Esempi OpenAPI: "id"
|
limite |
stringa |
query |
Falso |
Indica il numero massimo di risorse da restituire quando si elenca una raccolta. Esempi di URL: "limit=2" Esempi OpenAPI: "2" |
Risposta
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.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
elementi |
array[Qualsiasi tra: "volume_1.2_get_response_body", array[]] |
Vero |
|
metadati |
Vero |
Risposta tipo
{
"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"
}
}
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidParams |
vettore["invalidParams"] |
Falso |
Elenco dei parametri di query non validi |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
additionalDetails
type_astra_stateDetail
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
additionalDetails |
Falso |
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
type_astra_metadati
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema di metadati Astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Vero |
|
CreationTimestamp |
stringa |
Vero |
|
ModificationTimestamp |
stringa |
Vero |
|
CreatedBy |
stringa |
Vero |
|
modifiedBy |
stringa |
Falso |
volume_1.2_get_response_body
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Vero |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
nome |
stringa |
Vero |
Stringa JSON contenente il nome del volume. I valori definiti sono:
|
stato |
stringa |
Falso |
Stringa JSON contenente un valore che indica lo stato operativo del volume. |
dimensione |
stringa |
Falso |
Stringa JSON contenente la dimensione del volume. |
usato |
numero |
Falso |
Numero JSON contenente il numero di byte di quota utilizzati dal volume provisioned. |
usedPercentage |
numero |
Falso |
Numero JSON contenente la percentuale di volume utilizzato. |
totale |
numero |
Falso |
Numero JSON contenente il totale di byte dei volumi di cui è stato effettuato il provisioning. |
creationToken |
stringa |
Falso |
Stringa JSON contenente il token di creazione del volume. I valori definiti sono:
|
snapshotPossible |
stringa |
Falso |
Stringa JSON che indica se il driver può eseguire uno snapshot del volume. I valori definiti sono:
|
storageClass |
stringa |
Falso |
Stringa JSON contenente la classe di archiviazione per il volume.
|
pvcName |
stringa |
Falso |
Stringa JSON contenente il nome PersistentVolumeClaim (PVC) del volume.
|
internalName |
stringa |
Falso |
Stringa JSON contenente il nome interno del volume sul cluster di storage di destinazione, se disponibile. Questo nome viene ottenuto dal driver CSI di Kubernetes.
|
appsUsing |
array[string] |
Vero |
Array JSON di stringhe JSON, ciascuna contenente l'ID di un'applicazione che utilizza il volume. I valori definiti sono:
|
storageBackendID |
stringa |
Falso |
Stringa JSON contenente l'ID del backend di archiviazione che fornisce il volume. I valori definiti sono:
|
orchestratore |
stringa |
Falso |
Stringa JSON contenente l'orchestratore per questo volume. Questo sarà definito per i volumi Astra Data Store. I valori definiti sono:
|
serviceLevel |
stringa |
Falso |
Stringa JSON contenente la policy di qualità del servizio (QoS) definita per questo volume a livello di backend di storage. Questo sarà definito per i volumi Astra Data Store. |
exportPolicy |
stringa |
Falso |
Stringa JSON contenente la policy di esportazione associata a questo volume. Questo sarà definito per i volumi Astra Data Store. |
nodeId |
stringa |
Falso |
Stringa JSON contenente l'ID del nodo che gestisce il volume. Questo sarà definito per i volumi Astra Data Store. I valori definiti sono:
|
healthState |
stringa |
Falso |
Stringa JSON contenente un valore che indica lo stato di salute del volume. Questo sarà definito per i volumi Astra Data Store. I valori definiti sono:
|
healthStateDetails |
vettore["type_astra_stateDetail"] |
Vero |
Array JSON di oggetti JSON che elenca ulteriori dettagli sullo stato di salute attuale. Se non sono disponibili dettagli, questo array sarà vuoto.
|
metadati |
Vero |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
elenco_metadati_tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
continuare |
stringa |
Falso |
|
conta |
numero |
Falso |
|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |