Skip to main content
Astra Automation
Uma versão mais recente deste produto está disponível.
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Listar todas as notificações

PDFs

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

Retorna uma matriz JSON com todos os recursos correspondentes na coleção. Se campos individuais forem especificados na solicitação, a matriz JSON de itens conterá os campos solicitados para cada recurso correspondente na ordem especificada.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

incluir

string

consulta

Falso

Indica quais campos devem ser retornados ao listar uma coleção.

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

Exemplos OpenAPI: "id"

  • Exemplo: id,summary

limite

string

consulta

Falso

Indica o número máximo de recursos a serem retornados ao listar uma coleção.

Exemplos de URL: "limit=2"

Exemplos OpenAPI: "2"

  • exemplo: 4

filtro

string

consulta

Falso

Indica quais campos devem ser correspondidos para retornar um recurso ao listar uma coleção.

Os operadores suportados são:

  • eq - Igualdade

  • lt/gt - Menor que/Maior que

  • lte/gte - Menor ou igual a/Maior ou igual a

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

Exemplos OpenAPI: "campo eq 'valor'"

Ordenar

string

consulta

Falso

Indica a ordem de classificação dos recursos ao listar uma coleção.

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

Exemplos OpenAPI: "nome desc"

ignorar

string

consulta

Falso

Indica o número de recursos a serem ignorados ao listar uma coleção.

Exemplos de URL: "skip=1"

Exemplos OpenAPI: "1"

contar

string

consulta

Falso

Indica se o número total de recursos deve ser retornado no objeto metadados.

Exemplos de URL: "count=true"

Exemplos OpenAPI: "true"

  • exemplo: verdadeiro

continuar

consulta

Falso

Indica o token a partir do qual a listagem será retomada.

Exemplos de URL: "continue="

Exemplos OpenAPI: ""</continue>

Resposta

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 Obrigatório Descrição

itens

array[Qualquer um de: "notification_1.3_get_response_body", array[]]

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "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"
  }
}

Resposta

Status: 401, Unauthorized
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Resposta

Status: 400, Bad request
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidParams

array["invalidParams"]

Falso

Lista de parâmetros de consulta inválidos
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Resposta

Status: 403, Forbidden
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erro

Status: 404, Not found
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta de erro 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definições

Ver definições

dados

Objeto JSON contendo informações adicionais específicas do evento.

Nome Tipo Obrigatório Descrição

ttl

número

Falso

Número JSON que indica o número de segundos (desde o eventTime) que o evento será retido. Este campo só é incluído quando um evento é excluído automaticamente após o número de segundos especificado. Quando excluído, se o evento tiver um destino de notificação, todas as notificações associadas também serão excluídas. Quando excluído, se o evento tiver um destino de banner, o banner também será removido. A ausência deste campo (ou um valor de "0") significa que um evento não será excluído automaticamente.

isAcknowledgeable

string

Falso

String JSON que indica se o banner pode ser fechado. Os valores definidos são:

  • "verdadeiro" - O banner pode ser fechado

  • "falso" - O banner não pode ser fechado

tipo_astra_label

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

valor

string

Verdadeiro

tipo_metadados_astra

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Verdadeiro

CriaçãoTimestamp

string

Verdadeiro

Alteração do Timestamp

string

Verdadeiro

CreatedBy

string

Verdadeiro

modifiedBy

string

Falso

notification_1.3_get_response_body

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

Tipo de mídia do recurso. Os valores definidos são:

  • "application/astra-notification"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

id

string

Verdadeiro

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

nome

string

Verdadeiro

String JSON contendo um nome hierárquico para o evento, delimitado por um ponto (.). Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 127

  • Regex definido é: "^[a-z])(\.([a-z])+$"

sequenceCount

número

Verdadeiro

Número JSON contendo uma contagem sequencial. O número é incrementado pelo sistema cada vez que um novo evento é recebido.

resumo

string

Verdadeiro

String JSON contendo o resumo conciso (menos de 40 caracteres) do evento. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 79

eventTime

string

Verdadeiro

String JSON contendo um registro de data e hora que indica quando um evento ocorreu. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

fonte

string

Verdadeiro

String JSON contendo o nome em minúsculas do serviço que gerou um evento. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 19

  • A expressão regular definida é: "^([a-z-])*$"

ID do recurso

string

Verdadeiro

String JSON contendo o ID do recurso associado a um evento. Os valores definidos são:

  • Conforme o esquema de identificador Astra

IDs de recursos adicionais

array[string]

Verdadeiro

Array JSON de strings JSON, cada uma contendo o ID de um recurso adicional associado ao evento. Embora o campo "resourceID" contenha o recurso principal associado a este evento, este campo contém qualquer número de IDs de recursos adicionais a serem associados aos mesmos eventos. Se nenhum recurso adicional estiver associado ao evento, o array estará vazio. Os valores definidos são:

  • Conforme o esquema de identificador Astra

resourceType

string

Verdadeiro

String JSON contendo o tipo de mídia do recurso associado a um evento. Os valores definidos são:

  • Comprimento mínimo: 4

  • Comprimento máximo: 79

  • A expressão regular definida é: "^application\/astra-([a-zA-Z])+$"

ID de correlação

string

Verdadeiro

String JSON contendo um ID de correlação UUIDv4 que permite agrupar eventos relacionados. Os valores definidos são:

  • Conforme o esquema de identificador Astra

gravidade

string

Verdadeiro

String JSON contendo um dos seguintes valores que indicam a gravidade de um evento. Os valores definidos são:

  • "cleared" - Indica que um evento relatado anteriormente, que descrevia uma condição, não está mais ativo. Um evento com a gravidade "cleared" usará o mesmo resumo e ID de correlação para permitir que seja correspondido.

  • "Indeterminado" - Indica que a gravidade não pode ser determinada.

  • "Informativo" - Indica uma mudança de estado que é esperada e normal (não definida em X.733).

  • "warning" - Indica a detecção de uma falha potencial ou iminente que afetará o serviço, antes que quaisquer efeitos significativos sejam sentidos.

  • "Crítico" - Indica que ocorreu uma condição que afeta o serviço e que é necessária uma ação corretiva imediata. As definições de "resolvido", "indeterminado", "aviso" e "crítico" baseiam-se nas definições da cláusula 8.1.2.3 do CCITT X.733.

classe

string

Verdadeiro

String JSON contendo um dos seguintes valores que indicam a classe do evento. Os valores definidos são:

  • "sistema" - O evento está relacionado a um evento ou solicitação interna.

  • "usuário" - O evento está relacionado a um evento ou solicitação iniciada pelo usuário.

  • "security" - O evento está relacionado a uma questão de segurança.

descrição

string

Verdadeiro

String JSON contendo um texto descritivo extenso sobre o evento. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 1023

URL da descrição

string

Falso

String JSON contendo a URL que habilita e vincula um botão no banner à documentação externa. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 4095

correctiveAction

string

Falso

String JSON contendo um texto descritivo extenso sobre qual ação corretiva deve ser tomada em resposta ao evento. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 1023

URL de ação corretiva

string

Falso

String JSON contendo a URL que direciona um botão no banner para uma página na interface do usuário para corrigir o problema. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 4095

visibilidade

array[string]

Falso

Array JSON de strings JSON, cada uma indicando uma função RBAC com permissão para visualizar o evento. As funções são definidas em conjunto com o operador OR. Opcional. Se omitido, um usuário com qualquer função RBAC pode visualizar o evento. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

destinos

array[string]

Falso

Matriz JSON de strings JSON, cada uma indicando um destino adicional para o evento. Isso permite que um serviço forneça dicas sobre para onde um evento deve ser roteado, além do registro de atividades do serviço de Activity. Opcional. Os valores definidos são:

  • "notificação" - O evento é marcado como uma notificação e estará acessível através do endpoint da API de notificações.

  • "banner" - O evento está marcado como um banner.

  • "support" - O evento está marcado como um evento relacionado a suporte.

URI de recurso

string

Falso

String JSON contendo o URI associado ao evento. Incluída apenas para eventos relacionados a operações de API. Os valores definidos são:

  • Comprimento mínimo: 3

  • Comprimento máximo: 4095

URL da coleção de recursos

array[string]

Falso

Matriz JSON de strings JSON, cada uma indicando a URL de acesso completa do recurso associado ao evento. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 1023

resourceMethod

string

Falso

String JSON contendo o método HTTP invocado. Incluída apenas para eventos relacionados a operações de API. Os valores definidos são:

  • "opções" - operação da API OPTIONS

  • "post" - Operação POST da API

  • "get" - Operação GET da API

  • "put" - Operação de API PUT

  • "excluir" - operação de API DELETE

resourceMethodResult

string

Falso

String JSON contendo o resultado do método HTTP invocado. Incluída apenas para eventos relacionados às operações da API. Os valores definidos são:

  • A expressão regular definida é: "^[1-5][0-9]{2}$"

ID do usuário

string

Falso

String JSON contendo o ID do usuário associado a um evento. Incluída apenas para eventos associados a ações iniciadas pelo usuário. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID da conta

string

Falso

String JSON contendo o ID da conta associada a um evento. Incluída apenas para eventos associados a uma conta. Os valores definidos são:

  • Conforme o esquema de identificador Astra

dados

"dados"

Falso

Objeto JSON contendo informações adicionais específicas do evento.

metadados

"tipo_metadados_astra"

Verdadeiro

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

type_astra_metadata_list

Nome Tipo Obrigatório Descrição

continuar

string

Falso

contar

número

Falso

etiquetas

array["tipo_astra_label"]

Falso

CriaçãoTimestamp

string

Falso

Alteração do Timestamp

string

Falso

CreatedBy

string

Falso

modifiedBy

string

Falso

invalidParams

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do parâmetro de consulta inválido

razão

string

Verdadeiro

Motivo pelo qual o parâmetro de consulta é inválido