Recuperar un evento
GET /accounts/{account_id}/core/v1/events/{event_id}
Devuelve el recurso de la API de eventos almacenado en el cuerpo de respuesta JSON.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
evento_id |
cadena |
ruta |
Verdadero |
ID de la colección de eventos a listar |
Respuesta
Status: 200, Returns the stored Event API resource in the JSON response body.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene un nombre jerárquico en notación de puntos (.) para el evento. Los valores definidos son:
|
sequenceCount |
número |
Verdadero |
Número JSON que contiene un recuento de secuencias. El número es incrementado por el sistema cada vez que se recibe un nuevo evento. |
resumen |
cadena |
Verdadero |
Cadena JSON que contiene el resumen abreviado (menos de 40 caracteres) del evento. Los valores definidos son:
|
eventTime |
cadena |
Verdadero |
Cadena JSON que contiene una marca de tiempo que indica cuándo se produjo un evento. Los valores definidos son:
|
fuente |
cadena |
Verdadero |
Cadena JSON que contiene el nombre en minúsculas del servicio que genera un evento. Los valores definidos son:
|
resourceID |
cadena |
Verdadero |
Cadena JSON que contiene el ID del recurso asociado a un evento. Los valores definidos son:
|
additionalResourceIDs |
array[string] |
Verdadero |
Matriz JSON de cadenas JSON, cada una de las cuales contiene un ID de recurso de un recurso adicional asociado al evento. Mientras que el campo "resourceID" contiene el recurso principal asociado a este evento, este campo contiene cualquier número de ID de recursos adicionales que se asocien a los mismos eventos. Si no hay recursos adicionales asociados al evento, la matriz estará vacía. Los valores definidos son:
|
resourceType |
cadena |
Verdadero |
Cadena JSON que contiene el tipo de medio del recurso asociado a un evento. Los valores definidos son:
|
correlationID |
cadena |
Verdadero |
Cadena JSON que contiene un ID de correlación UUIDv4 que permite agrupar eventos relacionados. Los valores definidos son:
|
gravedad |
cadena |
Verdadero |
Cadena JSON que contiene uno de los siguientes valores que indican la gravedad de un evento. Los valores definidos son:
|
clase |
cadena |
Verdadero |
Cadena JSON que contiene uno de los siguientes valores que indican la clase del evento. Los valores definidos son:
|
descripción |
cadena |
Verdadero |
Cadena JSON que contiene un texto descriptivo largo sobre el evento. Los valores definidos son:
|
descripciónURL |
cadena |
Falso |
Cadena JSON que contiene la URL que habilita y enlaza un botón del banner a documentación externa. Los valores definidos son:
|
correctiveAction |
cadena |
Falso |
Cadena JSON que contiene un texto descriptivo largo sobre la acción correctiva que debe tomarse en respuesta al evento. Los valores definidos son:
|
correctiveActionURL |
cadena |
Falso |
Cadena JSON que contiene la URL que vincula un botón del banner a una página de la interfaz de usuario para solucionar el problema. Los valores definidos son:
|
visibilidad |
array[string] |
Falso |
Matriz JSON de cadenas JSON, cada una de las cuales indica un rol RBAC permitido para ver el evento. Los roles se definen juntos con OR. Opcional. Si se omite, un usuario con cualquier rol RBAC puede ver el evento. Los valores definidos son:
|
destinos |
array[string] |
Falso |
Matriz JSON de cadenas JSON, cada una de las cuales indica un destino adicional para el evento. Estas cadenas permiten a un servicio proporcionar pistas sobre a dónde debe dirigirse un evento además del registro de actividad. Opcional. Los valores definidos son:
|
resourceURI |
cadena |
Falso |
Cadena JSON que contiene el URI asociado al evento. Solo se incluye para eventos relacionados con operaciones de la API. Los valores definidos son:
|
resourceCollectionURL |
array[string] |
Falso |
Matriz JSON de cadenas JSON, cada una de las cuales indica la URL de acceso completamente expandida del recurso asociado al evento. Los valores definidos son:
|
resourceMethod |
cadena |
Falso |
Cadena JSON que contiene el método HTTP invocado. Solo se incluye para eventos relacionados con operaciones de la API. Los valores definidos son:
|
resourceMethodResult |
cadena |
Falso |
Cadena JSON que contiene el resultado del método HTTP invocado. Solo se incluye para eventos relacionados con las operaciones de la API. Los valores definidos son:
|
userID |
cadena |
Falso |
Cadena JSON que contiene el ID de usuario asociado a un evento. Solo se incluye para los eventos asociados a las acciones iniciadas por el usuario. Los valores definidos son:
|
accountID |
cadena |
Falso |
Cadena JSON que contiene el ID de cuenta asociado a un evento. Solo se incluye para eventos asociados a una cuenta. Los valores definidos son:
|
data |
Falso |
Objeto JSON que contiene información adicional específica del evento. |
|
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de respuesta
{
"type": "application/astra-event",
"version": "1.4",
"id": "c32df10b-8cfb-5a1e-9510-2a262b476009",
"name": "astra.app.discovery.failed",
"sequenceCount": 48923,
"summary": "Application Discovery Failed",
"eventTime": "2020-08-06T12:24:51.846543Z",
"source": "composite-compute",
"resourceID": "f670bf11-8850-44bd-b330-815af6186a06",
"additionalResourceIDs": [
"84dfee99-b7b2-46d2-9021-0a1a9a5df1d6",
"abb32003-07b9-49b1-9938-1cf6d2f33566"
],
"resourceType": "application/astra-app",
"correlationID": "3c603442-cfca-4af9-9f1b-40dde5c7a806",
"severity": "warning",
"class": "user",
"description": "Discovering the application 'mysql' was unsuccessful. K8s error 442. Application marked in state 'error'.",
"resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/managedClusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/apps/f670bf11-8850-44bd-b330-815af6186a06",
"resourceCollectionURL": [
"https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06",
"https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06"
],
"userID": "abda967f-cd2c-4237-908e-99266648c553",
"accountID": "f126d214-bccf-4558-86b4-2137a41e734f",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidParams |
array["invalidParams"] |
Falso |
Lista de parámetros de consulta no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Error
Status: 404, Not found
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
data
Objeto JSON que contiene información adicional específica del evento.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
ttl |
número |
Falso |
Número JSON que indica el número de segundos (desde eventTime) que se conservará el evento. Este campo solo se incluye cuando un evento se elimina automáticamente después del número de segundos especificado. Cuando se elimina, si el evento tiene un destino de notificación, también se eliminan todas las notificaciones asociadas. Cuando se elimina, si el evento tiene un destino de banner, también se elimina el banner. La ausencia de este campo (o un valor de "0") significa que un evento no se eliminará automáticamente. |
isAcknowledgeable |
cadena |
Falso |
Cadena JSON que indica si el banner se puede descartar. Los valores definidos son:
|
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
tipo_astra_metadatos
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
-
Cumple con el esquema de metadatos Astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Verdadero |
|
CreationTimestamp |
cadena |
Verdadero |
|
Modificación.Marca de hora |
cadena |
Verdadero |
|
CreatedBy |
cadena |
Verdadero |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |