Skip to main content
Astra Automation
È disponibile una versione più recente di questo prodotto.
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Elenca le app per un cluster gestito

GET /accounts/{account_id}/topology/v2/managedClusters/{managedCluster_id}/apps

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

  • esempio: {{.Account}}

ID cluster gestito

stringa

percorso

Vero

ID della risorsa managedCluster 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"

  • esempio: id,nome,stato

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:

  • eq - Uguaglianza

  • lt/gt - Minore di/Maggiore di

  • lte/gte - Minore o uguale a/Maggiore o uguale a

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: "app_2.2_get_response_body", array[]]

Vero

metadati

"elenco_metadati_tipo_astra"

Vero

Risposta tipo
{
  "type": "application/astra-apps",
  "version": "2.2",
  "items": [
    [
      "2ff50f4b-fe40-4980-913f-8a4469184822",
      "mysql",
      "ready"
    ],
    [
      "ae1e6561-9e22-406c-8a5a-762f4604da00",
      "jenkins",
      "ready"
    ]
  ],
  "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

targetSchema

accept-post

accetta-put

suggerimenti

Nome Tipo Obbligatorio Descrizione

stato

stringa

Falso

permettere

array[string]

Falso

accept-post

"accept-post"

Falso

autorizzazioni

array[string]

Falso

accetta-put

"accetta-put"

Falso

type_astra_link

Nome Tipo Obbligatorio Descrizione

rel

stringa

Vero

href

stringa

Vero

tipo

stringa

Falso

targetSchema

"targetSchema"

Falso

titolo

stringa

Falso

suggerimenti

"suggerimenti"

Falso

GVK

Oggetto JSON contenente un gruppo/versione/tipo di Kubernetes.

  • Questo oggetto viene convalidato internamente rispetto ad Astra/apiResources.

Nome Tipo Obbligatorio Descrizione

gruppo

stringa

Vero

Stringa JSON contenente un identificatore di gruppo assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

Tipo

stringa

Vero

Stringa JSON contenente un identificatore di tipo assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

versione

stringa

Vero

Stringa JSON contenente un identificatore di versione assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

clusterScopedResources

Nome Tipo Obbligatorio Descrizione

GVK

"GVK"

Vero

Oggetto JSON contenente un gruppo/versione/tipo di Kubernetes.

  • Questo oggetto viene convalidato internamente rispetto ad Astra/apiResources.

labelSelectors

array[string]

Falso

Array JSON di stringhe JSON che rappresentano un selettore di etichette per le GroupVersionKinds (GVK) a livello di cluster all'interno del cluster. Se questo è vuoto, allora tutte le istanze GVK presenti nel cluster sono incluse. Ogni elemento di questo array è una stringa di selettore di etichette Kubernetes e segue la stessa grammatica per tali valori. Esempi:

namespaceScopedResources

Nome Tipo Obbligatorio Descrizione

spazio dei nomi

stringa

Vero

Stringa JSON contenente il nome di un namespace in cui è definita l'applicazione. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 253

  • Conforme allo schema di etichette DNS 1123

labelSelectors

array[string]

Vero

Array JSON di stringhe JSON che rappresentano un selettore di etichette all'interno del namespace. Se vuoto, vengono incluse tutte le risorse del namespace. Ogni elemento di questo array è una stringa di selettore di etichette Kubernetes e segue la grammatica per tali valori. Esempi:

  • [ "app=mysql" ] — Seleziona tutte le risorse che hanno un'etichetta il cui nome è app e il cui valore è mysql

  • [ "app != mysql" ] — Seleziona tutte le risorse che hanno un'etichetta il cui nome è app e il cui valore non è mysql

  • [ "app in (mysql, mariadb)" ] — Seleziona tutte le risorse che hanno un'etichetta il cui nome è app e il cui valore è mysql o mariadb

  • [ "app notin (nginx, wordpress)" ] — Seleziona tutte le risorse che non hanno un'etichetta il cui nome è app e i cui valori sono nginx o wordpress

  • [ "app" ] — Seleziona tutte le risorse che hanno un'etichetta denominata app

  • [ "!app" ] — Seleziona tutte le risorse che non hanno un'etichetta denominata app Nota che è possibile includere più operatori di selezione in un singolo selettore, separati da virgole. In tal caso, i risultati dei singoli operatori di selezione vengono combinati con l'operatore AND:

  • [ "app=mysql,version=2" ] — Seleziona tutte le risorse che hanno un'etichetta il cui nome è app e il cui valore è mysql e un'etichetta il cui nome è version e il cui valore è 2

tipo_transizione_stato_astra

Nome Tipo Obbligatorio Descrizione

da

stringa

Vero

a

array[string]

Vero

additionalDetails

type_astra_stateDetail

Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

additionalDetails

"additionalDetails"

Falso

namespaceMapping

Nome Tipo Obbligatorio Descrizione

fonte

stringa

Vero

Stringa JSON contenente il nome del namespace sul cluster di origine. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 253

  • Conforme allo schema di etichette DNS 1123

destinazione

stringa

Vero

Stringa JSON contenente il nome del namespace sul cluster di destinazione. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 253

  • Conforme allo schema di etichette DNS 1123

storageClassMapping

Nome Tipo Obbligatorio Descrizione

fonte

stringa

Vero

Stringa JSON contenente il nome della classe di archiviazione di origine. Può anche essere '*' per specificare tutte le classi di archiviazione di origine. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

  • Conforme allo schema di etichette DNS 1123 se viene utilizzato il nome della Storage Class

  • '*' per specificare tutte le classi di archiviazione

destinazione

stringa

Vero

Stringa JSON contenente il nome della classe di archiviazione di destinazione. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

  • Conforme allo schema di etichette DNS 1123

GVKN

Nome Tipo Obbligatorio Descrizione

gruppo

stringa

Falso

Stringa JSON contenente un identificatore di gruppo assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

versione

stringa

Falso

Stringa JSON contenente un identificatore di versione assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

Tipo

stringa

Falso

Stringa JSON contenente un identificatore di tipo assegnato da Kubernetes.

  • Questa stringa viene convalidata internamente rispetto ad Astra/apiResources

spazi dei nomi

array[string]

Falso

Array JSON di stringhe JSON che descrivono i namespace da includere o escludere dalle risorse. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

  • Conforme allo schema di etichette DNS 1123

nomi

array[string]

Falso

Array JSON di stringhe JSON che descrivono i nomi delle risorse Kubernetes da includere o escludere dal ripristino selettivo. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 253

  • Conforme allo schema di etichette DNS 1123

labelSelectors

array[string]

Falso

Array JSON di stringhe JSON che descrivono i selettori di etichette Kubernetes utilizzati per includere o escludere risorse dal ripristino selettivo. Ogni elemento di questo array è una stringa di selettore di etichette Kubernetes e segue la stessa grammatica per tali valori. Esempi:

restoreFilter

Oggetto JSON contenente un elenco di filtri che descrivono quali risorse sono incluse o escluse da un'operazione di ripristino selettivo. Includi ed escludi si escludono a vicenda e un ripristino selettivo può utilizzare un solo tipo di filtro.

Nome Tipo Obbligatorio Descrizione

resourceSelectionCriteria

stringa

Falso

Stringa JSON contenente un valore che indica come i filtri delle risorse selezionano le risorse. I valori validi sono include o exclude.

GVKN

vettore["GVKN"]

Falso

Array JSON di oggetti JSON che descrivono le risorse da filtrare durante un ripristino selettivo. Una risorsa corrisponde a un singolo elemento filtro GVKN se tutti i campi filtro specificati corrispondono al campo risorsa corrispondente. I campi filtro che sono array (ad esempio, namespaces e nomi) corrispondono se almeno uno dei loro elementi corrisponde al campo risorsa corrispondente. Il campo labelSelectors richiede che tutti i selettori corrispondano. Una risorsa che corrisponde a qualsiasi filtro nell'array di oggetti filtro GVKN viene inclusa o esclusa dal ripristino in base al valore resourceSelectionCriteria. Specificare oggetti GVKN vuoti comporta un errore di convalida.

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

app_2.2_get_response_body

Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

Tipo di media della risorsa. I valori definiti sono:

  • "application/astra-app"

versione

stringa

Vero

Versione della risorsa. I valori definiti sono:

  • "2,0"

  • "2,1"

  • "2,2"

id

stringa

Vero

Identificatore univoco globale della risorsa. I valori definiti sono:

  • Conforme allo schema UUIDv4

collegamenti

vettore["type_astra_link"]

Vero

Collegamenti che descrivono le operazioni supportate sulla risorsa.

nome

stringa

Vero

Stringa JSON contenente un nome per l'applicazione. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

  • Questa stringa viene convalidata internamente per prevenire attacchi XSS, Unicode, directory traversal e SQL-injection.

  • Conforme allo schema di etichette DNS 1123

clusterScopedResources

vettore["clusterScopedResources"]

Falso

Array JSON di oggetti JSON che descrivono le risorse a livello di cluster che fanno parte di questa app

namespaceScopedResources

vettore["namespaceScopedResources"]

Vero

Array JSON di oggetti JSON che descrivono le risorse che fanno parte di questa app

lastResourceCollectionTimestamp

stringa

Falso

Stringa JSON contenente il timestamp dell'ultima raccolta di risorse. Questo campo non è impostato se non è stata ancora eseguita alcuna raccolta di risorse per questa applicazione. I valori definiti sono:

  • Conforme allo schema di data e ora ISO-8601

stato

stringa

Vero

Stringa JSON contenente un valore che indica lo stato operativo dell'applicazione. I valori definiti sono:

  • "in sospeso" - L'applicazione è programmata per la scoperta

  • "scoperta" - L'applicazione è in fase di scoperta

  • "Provisioning" - L'applicazione è in fase di provisioning

  • "pronto" - L'applicazione è in esecuzione normalmente

  • "fallito" - L'applicazione si trova in uno stato di errore permanente

  • "Ripristino" - L'applicazione viene ripristinata da backup o snapshot

  • "non disponibile" - L'applicazione non è attualmente accessibile

  • "sconosciuto" - Non è possibile determinare lo stato dell'applicazione

  • "eliminazione" - L'applicazione è in fase di eliminazione

stateTransitions

vettore["tipo_transizione_stato_astra"]

Falso

Array JSON di oggetti JSON, ognuno dei quali rappresenta l'insieme delle transizioni di stato consentite da un dato stato definito. Ogni oggetto JSON contiene i campi "from" e "to", dove il valore di "from" è il nome di uno stato e il valore di "to" è un array degli stati di destinazione consentiti.

stateDetails

vettore["type_astra_stateDetail"]

Vero

Array JSON di oggetti JSON che elenca dettagli aggiuntivi sullo stato corrente, incluso il motivo per cui è stato raggiunto tale stato. Se non sono disponibili dettagli, questo array sarà vuoto. I valori definiti sono:

  • Elementi minimi: 0

protectionState

stringa

Vero

Stringa JSON contenente un valore che indica lo stato di protezione dell'applicazione. I valori definiti sono:

  • "protetta" - L'applicazione ha una policy di protezione definita ed è conforme a tale policy

  • "parziale" - L'applicazione ha una policy di protezione definita, ma non è conforme a tale policy

  • "nessuno" - L'applicazione non ha una policy di protezione definita

  • "atRisk" - La classe di archiviazione predefinita sul cluster non supporta gli snapshot, l'applicazione rischia di ottenere un volume non supportato

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:

  • Elementi minimi: 0

appDetectedType

stringa

Falso

Stringa JSON che rappresenta in modo univoco il tipo specifico di applicazione rilevata. I valori definiti sono:

  • "system" - L'applicazione contiene una risorsa che la identifica come parte dell'ambiente Kubernetes

  • "acc" - L'applicazione contiene risorse che la identificano come un'istanza di Astra Control Center

spazi dei nomi

array[string]

Vero

Array JSON di stringhe JSON contenenti i nomi degli spazi dei nomi in cui è in esecuzione l'applicazione. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 253

  • Conforme allo schema di etichette DNS 1123

namespaceMapping

vettore["namespaceMapping"]

Falso

Array JSON di oggetti JSON, ciascuno dei quali mappa uno spazio dei nomi di origine a uno spazio dei nomi di destinazione per un'operazione di clonazione. I valori definiti sono:

  • Elementi minimi: 0

storageClassMapping

vettore["storageClassMapping"]

Falso

Array JSON di oggetti JSON, ognuno dei quali mappa una classe di archiviazione di origine a una classe di archiviazione di destinazione per un'operazione di ripristino. Se non sono presenti elementi o se questi non sono presenti, verranno utilizzati i nomi originali delle classi di archiviazione di origine. I valori definiti sono:

  • Elementi minimi: 0

clusterName

stringa

Falso

Stringa JSON contenente il nome del cluster su cui è in esecuzione l'applicazione. Non viene restituita se l'applicazione non è attualmente in esecuzione.

clusterID

stringa

Falso

Stringa JSON contenente l'ID del cluster su cui è in esecuzione l'applicazione. Non viene restituita se l'applicazione non è attualmente in esecuzione. Se specificato in fase di creazione, clusterID indica in quale cluster l'applicazione deve essere clonata. Se il cluster specificato non esiste, o se il cluster specificato non corrisponde al clusterID specificato nell'URI della richiesta, la clonazione non riuscirà. I valori definiti sono:

  • Conforme allo schema identificativo Astra

clusterType

stringa

Falso

Stringa JSON contenente un valore che indica il tipo di cluster. I valori definiti sono:

  • "gke" - Kubernetes ospitato su Google Kubernetes Engine (GKE)

  • "aks" - Kubernetes ospitato su Microsoft Azure Kubernetes Service (AKS)

  • "eks" - Kubernetes ospitato su Amazon Elastic Kubernetes Service (Amazon EKS)

  • "openshift" - Il cluster è di tipo OpenShift

  • "kubernetes" - Il cluster è Kubernetes generico

ID applicazione sorgente

stringa

Falso

Stringa JSON contenente l'ID di un'applicazione di origine. Viene restituita solo se l'applicazione è stata clonata da un'altra applicazione o è stata ripristinata da un backup o uno snapshot. Quando specificato in fase di creazione, il sourceAppID viene utilizzato insieme al sourceClusterID e indica quale applicazione in esecuzione verrà clonata. Se l'applicazione specificata non esiste sul cluster di origine, la clonazione non riuscirà. È possibile specificare solo uno tra sourceAppID, backupID o snapshotID durante la creazione di un'applicazione. I valori definiti sono:

  • Conforme allo schema identificativo Astra

sourceClusterName

stringa

Falso

Stringa JSON contenente il nome del cluster su cui l'applicazione era precedentemente in esecuzione. Restituita solo se l'applicazione è stata clonata da un altro cluster.

sourceClusterID

stringa

Falso

Stringa JSON contenente l'ID del cluster su cui l'applicazione era precedentemente in esecuzione. Restituita solo se l'applicazione è stata clonata da un altro cluster. Quando specificato in fase di creazione, il sourceClusterID viene utilizzato insieme al sourceAppID e indica il cluster di origine dell'applicazione da clonare. Se il cluster di origine specificato non esiste, la clonazione non andrà a buon fine. I valori definiti sono:

  • Conforme allo schema identificativo Astra

backupID

stringa

Falso

Stringa JSON contenente l'ID del backup da cui è stata ripristinata l'applicazione. Restituita solo se l'applicazione è stata ripristinata da un backup. Se specificato in fase di creazione, backupID indica che un'applicazione verrà clonata da un backup esistente. Se il backup specificato non esiste, la clonazione non andrà a buon fine. È possibile specificare solo uno tra sourceAppID, backupID o snapshotID durante la creazione di un'applicazione. Se specificato in fase di sostituzione, backupID indica il backup dell'applicazione da cui verrà ripristinata l'applicazione sul posto. Se il backup specificato non esiste, il ripristino non andrà a buon fine. È possibile specificare solo uno tra backupID o snapshotID durante l'aggiornamento di un'applicazione. I valori definiti sono:

  • Conforme allo schema identificativo Astra

snapshotID

stringa

Falso

Stringa JSON contenente l'ID dello snapshot da cui è stata ripristinata l'applicazione. Restituita solo se l'applicazione è stata ripristinata da uno snapshot. Se specificato in fase di creazione, snapshotID indica che un'applicazione verrà clonata da uno snapshot esistente. Se lo snapshot specificato non esiste, la clonazione non andrà a buon fine. È possibile specificare solo uno tra sourceAppID, backupID o snapshotID durante la creazione di un'applicazione. Se specificato in fase di sostituzione, snapshotID indica lo snapshot dell'applicazione da cui verrà ripristinata l'applicazione sul posto. Se lo snapshot specificato non esiste, il ripristino non andrà a buon fine. È possibile specificare solo uno tra backupID o snapshotID durante l'aggiornamento di un'applicazione. I valori definiti sono:

  • Conforme allo schema identificativo Astra

replicationSourceAppID

stringa

Falso

Stringa JSON contenente l'ID dell'applicazione che viene replicata in questa applicazione. Viene restituita solo se l'applicazione è attualmente la destinazione in una relazione AppMirror e la relazione non è nello stato failedOver. Quando la relazione è nello stato failedOver, questo campo non viene restituito. I valori definiti sono:

  • Conforme allo schema identificativo Astra

restoreFilter

"restoreFilter"

Falso

Oggetto JSON contenente un elenco di filtri che descrivono quali risorse sono incluse o escluse da un'operazione di ripristino selettivo. Includi ed escludi si escludono a vicenda e un ripristino selettivo può utilizzare un solo tipo di filtro.

metadati

"aggiornamento dei metadati di tipo Astra"

Vero

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.

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