Elenca tutti i cluster gestiti
GET /accounts/{account_id}/topology/v1/managedClusters
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" |
filtro |
stringa |
query |
Falso |
Indica quali campi devono essere confrontati per restituire una risorsa durante l'elenco di una collezione. Gli operatori supportati sono:
Esempio di URL: "filter=field%20eq%20%27value%27" Esempi OpenAPI: "field eq 'value'" |
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: "managedCluster_1.2_get_response_body", array[]] |
Vero |
|
metadati |
Vero |
Risposta tipo
{
"type": "application/astra-managedClusters",
"version": "1.2",
"items": [
[
"0f284377-e5dc-4dcd-bacd-3197f2b8a347",
"GKE-21",
"managed"
],
[
"04dc80fa-d1d8-4850-a49f-3b70d0ec1369",
"GKE-22",
"unmanaged"
]
],
"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 |
aggiornamento dei metadati di tipo Astra
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema dei metadati di Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
managedCluster_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 un nome per il cluster. I valori definiti sono:
|
stato |
stringa |
Vero |
Stringa JSON contenente un valore che indica lo stato operativo del cluster. I valori definiti sono:
|
restoreTargetSupported |
stringa |
Falso |
Stringa JSON contenente un valore che indica la capacità del cluster gestito di essere un target delle operazioni di gestione dei dati dell'applicazione. I valori definiti sono:
|
snapshotSupported |
stringa |
Falso |
Stringa JSON contenente un valore che indica la capacità del cluster gestito di eseguire operazioni di gestione dei dati delle applicazioni simili a backup. I valori definiti sono:
|
stateUnready |
array[string] |
Vero |
Array JSON di stringhe JSON, ognuna delle quali indica un motivo per cui il cluster non è in grado di passare allo stato "in esecuzione", quando si verificano problemi mentre è già in esecuzione, o perché è passato allo stato "non riuscito" o "rimosso". I valori definiti sono:
|
managedState |
stringa |
Vero |
Stringa JSON contenente un valore che indica lo stato di gestione del cluster. I valori definiti sono:
|
protectionState |
stringa |
Vero |
Stringa JSON contenente un valore che indica lo stato di protezione del cluster. I valori definiti sono:
|
protectionStateDetails |
vettore["type_astra_stateDetail"] |
Vero |
Array JSON di oggetti JSON che elenca dettagli aggiuntivi sullo stato di protezione corrente, incluso il motivo per cui è stato raggiunto tale stato. Se non sono disponibili dettagli, questo array sarà vuoto. I valori definiti sono:
|
managedStateUnready |
array[string] |
Vero |
Array JSON di stringhe JSON, ognuna delle quali indica un motivo per cui il cluster non è idoneo alla gestione. I valori definiti sono:
|
managedTimestamp |
stringa |
Vero |
Stringa JSON contenente il timestamp che indica quando il cluster è stato messo sotto gestione. I valori definiti sono:
|
tridentVersion |
stringa |
Falso |
Stringa JSON contenente la versione di Trident installata sul cluster. I valori definiti sono:
|
tridentManagedState |
stringa |
Falso |
Stringa JSON contenente uno di un insieme di valori enumerati che indicano lo stato di gestione di Trident su questo cluster. I valori definiti sono:
|
tridentManagedStateDesired |
stringa |
Falso |
Stringa JSON contenente un valore che indica lo stato di gestione desiderato per Trident. I valori definiti sono:
|
tridentManagedStateDetails |
vettore["type_astra_stateDetail"] |
Falso |
Array JSON di oggetti JSON che elenca ulteriori dettagli sul motivo per cui lo "stato" è passato a "gestito" o "non gestito". + Se non sono disponibili dettagli, questo array sarà vuoto.
|
tridentManagedStateAllowed |
array[string] |
Falso |
Stati che possono essere richiesti in un dato tridentManagedState. I seguenti stati possono essere richiesti in ciascuno stato definito:
|
inUse |
stringa |
Vero |
Stringa JSON contenente un valore che indica se il cluster ha applicazioni gestite e pertanto non può essere eliminato. I valori definiti sono:
|
accHost |
stringa |
Falso |
Stringa JSON che indica che questo cluster ospita l'istanza di Astra Control Center a cui si sta attualmente accedendo. I valori definiti sono:
|
clusterType |
stringa |
Vero |
Stringa JSON contenente un valore che indica il tipo di cluster. I valori definiti sono:
|
clusterVersion |
stringa |
Vero |
Stringa JSON contenente la rappresentazione della versione semantica dell'ambiente del cluster. Per i cluster Kubernetes, questa è la versione di Kubernetes. I valori definiti sono:
|
clusterVersionString |
stringa |
Vero |
Stringa JSON contenente un valore che indica le informazioni di versione estese per l'ambiente del cluster. Per i cluster Kubernetes, questa è la versione completa di Kubernetes. I valori definiti sono:
|
clusterCreationTimestamp |
stringa |
Falso |
Stringa JSON contenente il timestamp che indica quando il cluster è stato originariamente creato. I valori definiti sono:
|
spazi dei nomi |
array[string] |
Falso |
Array JSON di stringhe JSON, ognuna delle quali indica uno spazio dei nomi all'interno del cluster. I valori definiti sono:
|
defaultStorageClass |
stringa |
Falso |
Stringa JSON contenente un ID di classe di archiviazione corrispondente alla classe di archiviazione predefinita, come impostata in Kubernetes. I valori definiti sono:
|
cloudID |
stringa |
Vero |
Stringa JSON contenente un valore che indica l'ID del cloud su cui è in esecuzione il cluster. I valori definiti sono:
|
ID credenziale |
stringa |
Falso |
Stringa JSON contenente un valore che indica l'ID della credenziale che contiene il file kubeconfig per il cluster. I valori definiti sono:
|
posizione |
stringa |
Falso |
Stringa JSON contenente un valore fornito dal cloud su cui è in esecuzione il cluster, che indica la posizione specifica del cluster nel cloud. I valori definiti sono:
|
isMultizonal |
stringa |
Vero |
Stringa JSON contenente un valore fornito dal cloud su cui è in esecuzione il cluster, che indica se il cluster si estende su due o più zone di disponibilità. I valori definiti sono:
|
privateRouteID |
stringa |
Falso |
Stringa JSON contenente il locationID per i cluster privati.
|
apiServiceID |
stringa |
Falso |
Stringa JSON contenente l'UUID dell'oggetto del servizio API di Kubernetes (k8s). Utilizzata per identificare in modo univoco un cluster. |
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 |