Ferramenta GraphiQL

Usando o GraphiQL, é possível explorar as consultas de esquema e de teste para o terminal GraphQL.

1. Baixar e instalar GraphiQL.
2. Abra o aplicativo GraphiQL e insira os cabeçalhos de HTTP que você deseja autorizar.
3. Insira o terminal correto no campo Terminal do GraphQl. Use o https://api.cis.cloud.ibm.com/v1/<crn>/zones/<zoneid>/graphql.

A janela é dividida em uma área de janela de consulta e uma de resposta. É possível definir as variáveis de consulta, que são interpoladas na consulta na área de janela de consulta.

Para construir uma consulta, siga estas etapas.

1. Selecione POST no menu de listagem Método.
2. Clique em Editar cabeçalhos de HTTP.
3. Insira o token X-Auth-User-Token ou de Autorização e configure o Content-Type: application/json. Certifique-se de salvá-los.

Comece a construir sua consulta na área de janela de consulta. Use o Explorer do documento para explorar o esquema e a documentação. O Explorer do Documento mostra as diferentes opções disponíveis para conjuntos de dados, dimensões, operações e funções. As palavras "zona" e "domínio" são sinônimas no Explorer do Documento.

Cole o fragmento de teste a seguir na área de janela de consulta e observe a resposta na área de janela de resposta, ajustando o datetime para atender às suas necessidades.

query {
   viewer {
      zones(filter: {zoneTag: "<your domain ID>"}) {
         httpRequests1hGroups(limit: 5, filter: { datetime_gt: "2020-08-30T04:00:00Z", datetime_lt: "2020-08-31T06:00:00Z"}) {
            sum {
              countryMap {
                bytes
                clientCountryName
              }
            }
            dimensions {
              date
              datetime
             }
          }
         firewallEventsAdaptiveGroups(limit: 10, filter: { datetime_gt: "2020-08-30T04:00:00Z", datetime_lt: "2020-08-31T06:00:00Z"}) {
               count
               dimensions {
                  clientCountryName
                  clientAsn
                  datetimeHour
               }
             }
          }
       }
     }

Configurações de consulta para limites de conta

Para obter informações específicas relativas a limites para um nó de dados, use o nó settings.

A seguir, uma consulta de exemplo:

{
  viewer {
    zones(filter: { zoneTag: $zoneTag }) {
      settings {
        browserInsightsAdaptiveGroups {
          maxDuration
          maxNumberOfFields
          maxPageSize
          enabled
          notOlderThan
        }
      }
    }
  }
}

A resposta da consulta segue:

{
  "data": {
    "viewer": {
      "zones": [
        {
          "settings": {
            "browserInsightsAdaptiveGroups": {
              "enabled": true,
              "maxDuration": 2592000,
              "maxNumberOfFields": 30,
              "maxPageSize": 10000,
              "notOlderThan": 2595600
            }
          }
        }
      ]
    }
  },
  "errors": null
}

Limites de consulta

O volume de dados que uma consulta pode retornar é limitado e há limites de usuários no volume de dados diários. Os limites a seguir aplicam-se além dos limites gerais de taxa impostos pela API:

• Uma consulta com escopo definido na zona pode incluir até 10 zonas.
• As consultas podem solicitar até 30 campos conforme indicado por maxNumberOfFields em settings.
• As respostas podem retornar até 10.000 registros. Esse limite é indicado por maxPageSize em settings.

As consultas devem especificar explicitamente o número máximo de registros a serem retornados por meio do argumento limit .

Exemplos de classificação

Classificação de dados brutos:

firewallEventsAdaptive (orderBy: [clientCountryName_ASC]) {
    clientCountryName
}

Classificação de dados brutos usando vários campos:

firewallEventsAdaptive (orderBy: [clientCountryName_ASC, datetime_DESC]) {
    clientCountryName
    datetime
}

Classificação de grupo por função de agregação:

httpRequests1hGroups (orderBy: [sum_bytes_DESC]){
    sum {
        bytes
        requests
    }
    dimensions {
        datetime
    }
}

Páginas de consulta sem cursores

Os exemplos a seguir supõem que os relacionamentos date e clientCountryName são exclusivos.

Obtenha os primeiros n resultados de uma consulta.

Para limitar os resultados, inclua o parâmetro limit. Por exemplo, consultar os dois primeiros registros.

firewallEventsAdaptive (limit: 2, orderBy: [datetime_ASC, clientCountryName_ASC]) {
    datetime
    clientCountryName
}

A especificação de uma ordem de classificação por data retorna resultados menos específicos do que a especificação de uma ordem de classificação por data e país.

A resposta da consulta segue:

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UM"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "US"
    }
  ]
}

Consultar a próxima página usando filtro

Para obter os próximos n resultados, especifique um filtro para excluir o último resultado da consulta anterior. Usando o exemplo anterior, é possível anexar o operador maior que (_gt) ao campo clientCountryName e o operadormaior ou igual ao campo datetime. Ao criar uma ordem específica, é possível obter os resultados mais completos.

firewallEventsAdaptive (limit: 2, orderBy: [datetime_ASC, clientCountryName_ASC], filter: {date_geq: "2018-11-12T00:00:00Z", clientCounterName_gt: "US"}) {
    date
    clientCountryName
}

A resposta da consulta segue:

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UY"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UZ"
    }
  ]
}

Consultar a página anterior

Para obter os resultados n anteriores, inverta os filtros e a ordem de classificação.

firewallEventsAdaptive (limit: 2, orderBy: [datetime_DESC, clientCountryName_DESC, filter: {date_leq: "2018-11-12T00:00:00Z", clientCountryName_lt: "UY"}]) {
  datetime
  clientCountryName
}

A resposta da consulta segue:

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "US"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UM"
    }
  ]
}

Estrutura

O filtro “ GraphQL ” é representado pelo objeto de entrada “ GraphQL ”.

Os filtros podem ser usados como um argumento nos recursos a seguir:

• Zonas (domínios)
• Tabelas (conjuntos de dados)
• Contas

Filtro de zona (domínio)

O filtro de zona permite a consulta de dados relacionados à zona por ID da zona (domínio) (zoneTag).

zones(filter: {zoneTag: "your domain (zone) ID"}) {
    ...
}

O filtro de zona deve estar em conformidade com a gramática a seguir:

filter
    { zoneTag: t }
    { zoneTag_gt: t }
    { zoneTag_in: [t, ...] }

Os filtros compostos (separados por vírgula, AND, OR) não são suportados. As zonas são sempre classificadas de maneira alfanumérica.

Filtro de tabela (conjunto de dados)

Os filtros de tabela requerem que você consulte pelo menos um nó. O operador AND pode ser usado para criar e combinar filtros multinós.

Filtro de contas

A filtragem de nível de conta é suportada e há um parâmetro de filtro necessário. Por exemplo:

accounts(filter: {accountTag: $accountTag}) {
    ...
}

Operadores

O suporte ao operador varia, dependendo do tipo de nó e do nome do nó. Os operadores a seguir são suportados para todos os tipos:

Exemplos

Exemplo geral:

{
  myQuery(
    filter: {
      clientCountry: "UK" # all objects having client country equal to "UK"
      datetime_gt: "2020-01-01 10:00:00" # all object having datetime greater than "2020-01-01 10:00:00"
    }
  )
}

Filtrar um nó específico:

httpRequests1hGroups(filter: {datetime: "2020-01-01 10:00:00"}) {
    ...
}

Filtrar em vários campos:

httpRequests1hGroups(filter: {datetime_gt: "2018-01-01 10:00:00", datetime_lt: "2018-01-01 11:00:00"}) {
    ...
}

Filtrar usando o operador OR:

httpRequests1hGroups(filter: {
    datetime: "2020-01-01 10:00:00",
    OR:[{clientCountryName: "US"}, {clientCountryName: "UK"}]) {
    ...
}