Elenca tutti gli eventi
GET /accounts/{account_id}/core/v1/events
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'" |
OrderBy |
stringa |
query |
Falso |
Indica l'ordine di visualizzazione delle risorse durante l'elenco di una collezione. Esempi di URL: "orderBy=name", "orderBy=name%20desc" Esempi OpenAPI: "name desc" |
saltare |
stringa |
query |
Falso |
Indica il numero di risorse da saltare durante l'elenco di una raccolta. Esempi di URL: "skip=1" Esempi OpenAPI: "1" |
conta |
stringa |
query |
Falso |
Indica se il numero totale di risorse deve essere restituito nell'oggetto metadata. Esempi di URL: "count=true" Esempi OpenAPI: "true" |
continuare |
query |
Falso |
Indica il token da cui riprendere l'elenco. Esempi di URL: "continue= Esempi OpenAPI: " |
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: "event_1.4_get_response_body", array[]] |
Vero |
|
metadati |
Vero |
Risposta tipo
{
"type": "application/astra-events",
"version": "1.4",
"items": [
[
"4f8273ee-883d-47f0-a512-9e27b6285f20",
"Discovering Applications in Cluster"
],
[
"1cdd26dc-5eb0-4cf4-a0c1-39a9b83720e1",
"Application Discovered"
],
[
"2064d1c1-4bc6-466e-9c30-b941a11be16a",
"Application Discovery Failed"
],
[
"4325f971-ca9c-4a52-bc9a-da6ec62e6bfe",
"Application Discovered"
]
],
"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
dati
Oggetto JSON contenente informazioni aggiuntive specifiche dell'evento.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
ttl |
numero |
Falso |
Numero JSON che indica il numero di secondi (dall'eventTime) per cui l'evento verrà conservato. Questo campo è incluso solo quando un evento viene eliminato automaticamente dopo il numero di secondi specificato. Quando viene eliminato, se l'evento ha una destinazione di notifica, vengono eliminate anche tutte le notifiche associate. Quando viene eliminato, se l'evento ha una destinazione banner, viene rimosso anche il banner. L'assenza di questo campo (o un valore di "0") significa che un evento non verrà eliminato automaticamente. |
isAcknowledgeable |
stringa |
Falso |
Stringa JSON che indica se il banner è chiudibile. I valori definiti sono:
|
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 |
event_1.4_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 gerarchico dell'evento in notazione puntata (.). I valori definiti sono:
|
sequenceCount |
numero |
Vero |
Numero JSON contenente un conteggio sequenziale. Il numero viene incrementato dal sistema ogni volta che viene ricevuto un nuovo evento. |
riepilogo |
stringa |
Vero |
Stringa JSON contenente il riepilogo breve (meno di 40 caratteri) dell'evento. I valori definiti sono:
|
eventTime |
stringa |
Vero |
Stringa JSON contenente un timestamp che indica quando si è verificato un evento. I valori definiti sono:
|
fonte |
stringa |
Vero |
Stringa JSON contenente il nome in minuscolo del servizio che genera un evento. I valori definiti sono:
|
ID risorsa |
stringa |
Vero |
Stringa JSON contenente l'ID della risorsa associata a un evento. I valori definiti sono:
|
ID risorsa aggiuntivi |
array[string] |
Vero |
Array JSON di stringhe JSON, ciascuna contenente un ID risorsa di una risorsa aggiuntiva associata all'evento. Mentre il campo "resourceID" contiene la risorsa principale associata a questo evento, questo campo contiene un qualsiasi numero di ID risorsa aggiuntivi da associare agli stessi eventi. Se non sono associate risorse aggiuntive all'evento, l'array sarà vuoto. I valori definiti sono:
|
resourceType |
stringa |
Vero |
Stringa JSON contenente il tipo di media della risorsa associata a un evento. I valori definiti sono:
|
ID correlazione |
stringa |
Vero |
Stringa JSON contenente un ID di correlazione UUIDv4 che consente di raggruppare eventi correlati. I valori definiti sono:
|
gravità |
stringa |
Vero |
Stringa JSON contenente uno dei seguenti valori che indicano la gravità di un evento. I valori definiti sono:
|
classe |
stringa |
Vero |
Stringa JSON contenente uno dei seguenti valori che indicano la classe dell'evento. I valori definiti sono:
|
descrizione |
stringa |
Vero |
Stringa JSON contenente un testo descrittivo esteso sull'evento. I valori definiti sono:
|
descrizioneURL |
stringa |
Falso |
Stringa JSON contenente l'URL che abilita e collega un pulsante nel banner alla documentazione esterna. I valori definiti sono:
|
correctiveAction |
stringa |
Falso |
Stringa JSON contenente un testo descrittivo esteso sulle azioni correttive da intraprendere in risposta all'evento. I valori definiti sono:
|
URL dell'azione correttiva |
stringa |
Falso |
Stringa JSON contenente l'URL che collega un pulsante nel banner a una pagina all'interno dell'interfaccia utente per risolvere il problema. I valori definiti sono:
|
visibilità |
array[string] |
Falso |
Array JSON di stringhe JSON, ognuna delle quali indica un ruolo RBAC autorizzato a visualizzare l'evento. I ruoli sono definiti insieme tramite l'operatore OR. Facoltativo. Se omesso, un utente con qualsiasi ruolo RBAC può visualizzare l'evento. I valori definiti sono:
|
destinazioni |
array[string] |
Falso |
Array JSON di stringhe JSON, ognuna delle quali indica una destinazione aggiuntiva per l'evento. Queste stringhe consentono a un servizio di fornire suggerimenti su dove un evento dovrebbe essere instradato oltre al registro delle attività. Facoltativo. I valori definiti sono:
|
URI della risorsa |
stringa |
Falso |
Stringa JSON contenente l'URI associato all'evento. Inclusa solo per gli eventi relativi alle operazioni API. I valori definiti sono:
|
URL della raccolta risorse |
array[string] |
Falso |
Array JSON di stringhe JSON, ciascuna delle quali indica l'URL di accesso completo della risorsa associata all'evento. I valori definiti sono:
|
resourceMethod |
stringa |
Falso |
Stringa JSON contenente il metodo HTTP invocato. Inclusa solo per gli eventi relativi alle operazioni API. I valori definiti sono:
|
resourceMethodResult |
stringa |
Falso |
Stringa JSON contenente il risultato del metodo HTTP invocato. Inclusa solo per gli eventi relativi alle operazioni API. I valori definiti sono:
|
ID utente |
stringa |
Falso |
Stringa JSON contenente l'ID utente associato a un evento. Inclusa solo per gli eventi associati ad azioni avviate dall'utente. I valori definiti sono:
|
ID account |
stringa |
Falso |
Stringa JSON contenente l'ID dell'account associato a un evento. Inclusa solo per gli eventi associati a un account. I valori definiti sono:
|
dati |
Falso |
Oggetto JSON contenente informazioni aggiuntive specifiche dell'evento. |
|
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 |