Skip to main content
Astra Automation
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Listar todas las notificaciones

PDF

GET /accounts/{account_id}/core/v1/notifications

Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.

Parámetros

Nombre Tipo En Obligatorio Descripción

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

  • ejemplo: {{.Account}}

incluya

cadena

consulta

Falso

Indica qué campos deben devolverse al listar una colección.

Ejemplos de URL: "include=id", "include=id,name"

Ejemplos OpenAPI: "id"

  • ejemplo: id,resumen

límite

cadena

consulta

Falso

Indica el número máximo de recursos a devolver al listar una colección.

Ejemplos de URL: "limit=2"

Ejemplos OpenAPI: "2"

  • ejemplo: 4

filtro

cadena

consulta

Falso

Indica qué campos deben coincidir para devolver un recurso al listar una colección.

Los operadores admitidos son:

  • eq - Igualdad

  • lt/gt - Menor que/Mayor que

  • lte/gte - Menor o igual que/Mayor o igual que

Ejemplo de URL: "filter=field%20eq%20%27value%27"

Ejemplos OpenAPI: "field eq 'value'"

OrderBy

cadena

consulta

Falso

Indica el orden de clasificación de los recursos al listar una colección.

Ejemplos de URL: "orderBy=name", "orderBy=name%20desc"

Ejemplos OpenAPI: "name desc"

omitir

cadena

consulta

Falso

Indica el número de recursos que deben omitirse al listar una colección.

Ejemplos de URL: "skip=1"

Ejemplos OpenAPI: "1"

cuente

cadena

consulta

Falso

Indica si se debe devolver el número total de recursos en el objeto de metadatos.

Ejemplos de URL: "count=true"

Ejemplos de OpenAPI: "true"

  • ejemplo: true

continuar

consulta

Falso

Indica el token desde el que reanudar el listado.

Ejemplos de URL: "continue="

Ejemplos OpenAPI: ""</continue>

Respuesta

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.
Nombre Tipo Obligatorio Descripción

artículos

array[Cualquiera de: "notification_1.3_get_response_body", array[]]

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero
Ejemplo de respuesta 
{
  "type": "application/astra-notifications",
  "version": "1.3",
  "items": [
    [
      "4f8273ee-883d-47f0-a512-9e27b6285f20",
      "Discovering Applications in Cluster"
    ],
    [
      "1cdd26dc-5eb0-4cf4-a0c1-39a9b83720e1",
      "Application Discovered"
    ],
    [
      "275a8c6f-ebf6-4d10-b671-77d1b8c7c0a6",
      "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"
  }
}

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

matriz["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:

  • "true" - La pancarta se puede descartar

  • "false" - La pancarta no se puede descartar

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 con el 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

notification_1.3_get_response_body

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-notification"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

id

cadena

Verdadero

Identificador único global del recurso. Los valores definidos son:

  • Cumple con el esquema UUIDv4

nombre

cadena

Verdadero

Cadena JSON que contiene un nombre jerárquico en notación de puntos (.) para el evento. Los valores definidos son:

  • Longitud mínima: 3

  • Longitud máxima: 127

  • La expresión regular definida es: "^[a-z])(\.([a-z])+$"

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:

  • Longitud mínima: 3

  • Longitud máxima: 79

eventTime

cadena

Verdadero

Cadena JSON que contiene una marca de tiempo que indica cuándo se produjo un evento. Los valores definidos son:

  • Cumple con el esquema de fecha y hora ISO-8601

fuente

cadena

Verdadero

Cadena JSON que contiene el nombre en minúsculas del servicio que genera un evento. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 19

  • La expresión regular definida es: "^([a-z-])*$"

resourceID

cadena

Verdadero

Cadena JSON que contiene el ID del recurso asociado a un evento. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

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. Aunque 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:

  • Cumple con el esquema del identificador Astra

resourceType

cadena

Verdadero

Cadena JSON que contiene el tipo de medio del recurso asociado a un evento. Los valores definidos son:

  • Longitud mínima: 4

  • Longitud máxima: 79

  • La expresión regular definida es: "^application\/astra-([a-zA-Z])+$"

correlationID

cadena

Verdadero

Cadena JSON que contiene un ID de correlación UUIDv4 que permite agrupar eventos relacionados. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

gravedad

cadena

Verdadero

Cadena JSON que contiene uno de los siguientes valores que indican la gravedad de un evento. Los valores definidos son:

  • "cleared" - Indica que un evento previamente reportado que describe una condición ya no está activo. Un evento con gravedad "cleared" usará el mismo resumen e ID de correlación para permitir su cotejo.

  • "indeterminado" - Indica que no se puede determinar la gravedad.

  • "informativo" - Indica un cambio de estado que es esperado y normal (no definido en X.733).

  • "alerta" - Indica la detección de un fallo potencial o inminente que afecta al servicio, antes de que se hayan producido efectos significativos.

  • "critical" - Indica que se ha producido una condición que afecta al servicio y se requiere una acción correctiva inmediata. Las definiciones de "cleared", "indeterminate", "warning" y "critical" se basan en las definiciones de la cláusula 8.1.2.3 de CCITT X.733.

clase

cadena

Verdadero

Cadena JSON que contiene uno de los siguientes valores que indican la clase del evento. Los valores definidos son:

  • "sistema" - El evento está relacionado con un evento o solicitud interna.

  • "usuario" - El evento está relacionado con un evento o solicitud iniciado por el usuario.

  • "seguridad" - El evento está relacionado con un problema de seguridad.

descripción

cadena

Verdadero

Cadena JSON que contiene un texto descriptivo largo sobre el evento. Los valores definidos son:

  • Longitud mínima: 3

  • Longitud máxima: 1023

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:

  • Longitud mínima: 3

  • Longitud máxima: 4095

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:

  • Longitud mínima: 3

  • Longitud máxima: 1023

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:

  • Longitud mínima: 3

  • Longitud máxima: 4095

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:

  • Longitud mínima: 1

  • Longitud máxima: 63

destinos

array[string]

Falso

Matriz JSON de cadenas JSON, cada una de las cuales indica un destino adicional para el evento. Permiten a un servicio proporcionar pistas sobre dónde debe enrutarse un evento además del registro de actividad del servicio Activity. Opcional. Los valores definidos son:

  • "notification" - El evento se marca como notificación y será accesible a través del punto final de la API de notificaciones.

  • "banner" - El evento se marca como banner.

  • "soporte" - El evento se marca como un evento relacionado con el soporte.

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:

  • Longitud mínima: 3

  • Longitud máxima: 4095

resourceCollectionURL

array[string]

Falso

Matriz JSON de cadenas JSON, cada una de las cuales indica la URL de acceso completamente expandida del recurso asociado con el evento. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 1023

resourceMethod

cadena

Falso

Cadena JSON que contiene el método HTTP invocado. Incluida solo para eventos relacionados con operaciones de API. Los valores definidos son:

  • "options" - Operación de la API OPTIONS

  • "post" - Operación POST de la API

  • "get" - operación GET de la API

  • "put" - Operación PUT de la API

  • "delete" - operación DELETE de la API

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:

  • La expresión regular definida es: "^[1-5][0-9]{2}$"

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:

  • Cumple con el esquema del identificador Astra

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:

  • Cumple con el esquema del identificador Astra

data

"data"

Falso

Objeto JSON que contiene información adicional específica del evento.

metadatos

"tipo_astra_metadatos"

Verdadero

Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:

  • Cumple con el esquema de metadatos Astra

type_astra_metadata_list

Nombre Tipo Obligatorio Descripción

continuar

cadena

Falso

cuente

número

Falso

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

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