GraphiQL attrezzo

Utilizzando GraphiQL, puoi esplorare lo schema e testare le query per GraphQL punto finale.

1. Scarica e installa GraphiQL.
2. Apri l'applicazione " GraphiQL " e inserisci le intestazioni " HTTP " che desideri autorizzare.
3. Inserisci l'endpoint corretto nel file GraphQl Punto finale campo. Utilizzo https://api.cis.cloud.ibm.com/v1/<crn>/zones/<zoneid>/graphql.

La finestra è divisa in un riquadro delle query e un riquadro delle risposte. È possibile definire le variabili di query, che vengono interpolate nella query nel riquadro delle query.

Per creare una query, attenersi alla seguente procedura.

1. Selezionare POST dal Metodo menù elenco.
2. Fare clic su Modifica intestazioni HTTP.
3. Inserisci il X-Auth-User-Token o Token di autorizzazione e imposta il tipo di contenuto:application/json. Assicurati di salvarli.

Inizia a creare la tua query nel riquadro delle query. Usa il Esplora documenti per esplorare lo schema e la documentazione. Document Explorer mostra le diverse opzioni disponibili per set di dati, dimensioni, operazioni e funzioni. Le parole "zona" e "dominio" sono sinonimi in Document Explorer.

Incolla il seguente snippet di test nel riquadro delle query e osserva la risposta nel riquadro delle risposte, modificando il file datetime per soddisfare le tue esigenze

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
               }
             }
          }
       }
     }

Impostazioni delle query per i limiti dell'account

Per ottenere informazioni specifiche sui limiti per un nodo dati, utilizzare il file settings nodo.

Di seguito è riportata una query di esempio:

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

Segue la risposta alla domanda:

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

Limiti delle query

Il volume di dati che una query può restituire è limitato e sono previsti limiti utente sul volume di dati giornaliero. I seguenti limiti si applicano in aggiunta ai limiti tariffari generali applicati dall'API:

• Una query con ambito zona può includere fino a 10 zone.
• Le query possono richiedere fino a 30 campi come indicato da maxNumberOfFields In settings.
• Le risposte possono restituire fino a 10.000 record. Questo limite è indicato da maxPageSize In settings.

Le query devono specificare esplicitamente il numero massimo di record da restituire utilizzando l'argomento limit .

Esempi di ordinamento

Ordinamento dei dati grezzi:

firewallEventsAdaptive (orderBy: [clientCountryName_ASC]) {
    clientCountryName
}

Ordinamento dei dati grezzi utilizzando più campi:

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

Ordinamento dei gruppi per funzione di aggregazione:

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

Interroga le pagine senza cursori

Gli esempi seguenti presuppongono questo date E clientCountryName le relazioni sono uniche.

Prendi il primo N risultati di una query.

Per limitare i risultati, aggiungi il file limit parametro. Ad esempio, interroga i primi due record.

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

Specificare un ordinamento per data restituisce risultati meno specifici rispetto a specificare un ordinamento sia per data che per paese.

Segue la risposta alla domanda:

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

Richiedi la pagina successiva utilizzando il filtro

Per ottenere il prossimo N risultati, specificare un filtro per escludere l'ultimo risultato dalla query precedente. Utilizzando l'esempio precedente, è possibile aggiungere l'operatore maggiore di (_gt ) al clientCountryName campo e l'operatore maggiore o uguale al datetime campo. Effettuando un ordine specifico, puoi ottenere i risultati più completi.

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

Segue la risposta alla domanda:

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

Interroga la pagina precedente

Per ottenere il precedente N risultati, invertire i filtri e ordinare.

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

Segue la risposta alla domanda:

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

Struttura

IL GraphQL il filtro è rappresentato da GraphQL Oggetto di input.

I filtri possono essere utilizzati come argomento nelle seguenti risorse:

• Zone (Domini)
• Tabelle (set di dati)
• Account

Filtro di zona (dominio).

Il filtro di zona consente di interrogare i dati relativi alla zona in base all'ID della zona (dominio) (zoneTag ).

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

Il filtro di zona deve essere conforme alla seguente grammatica:

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

Filtri composti (separati da virgole,AND,OR ) non sono supportati. Le zone vengono sempre ordinate alfanumericamente.

Filtro tabella (set di dati).

I filtri di tabella richiedono l'esecuzione di una query su almeno un nodo. IL AND L'operatore può essere utilizzato per creare e combinare filtri multinodo.

Filtro account

Il filtro a livello di account è supportato ed è presente un parametro di filtro obbligatorio. Ad esempio:

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

Operatori

Il supporto dell'operatore varia a seconda del tipo e del nome del nodo. Per tutti i tipi sono supportati i seguenti operatori:

Esempi

Esempio generale:

{
  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"
    }
  )
}

Filtra un nodo specifico:

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

Filtra su più campi:

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

Filtra utilizzando OR operatore:

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