Herramienta GraphiQL

Utilizando GraphiQL, puede explorar las consultas de esquema y de prueba para el punto final de GraphQL.

1. Descargar e instalar GraphiQL.
2. Abra la aplicación GraphiQL y especifique las cabeceras HTTP que desee autorizar.
3. Especifique el punto final correcto en el campo Punto final de GraphQl. Utilice https://api.cis.cloud.ibm.com/v1/<crn>/zones/<zoneid>/graphql.

La ventana se divide en un panel de consulta y un panel de respuesta. Puede definir las variables de consulta, que se interpolaron en la consulta en el panel de consulta.

Para crear una consulta, siga estos pasos.

1. Seleccione POST en el menú de lista Método.
2. Pulse Editar cabeceras HTTP.
3. Especifique la señal X-Auth-User-Token o de autorización, y establezca Content-Type: application/json. Asegúrese de guardarlos.

Empiece a crear la consulta en el panel de consulta. Utilice el Explorador de documentos para explorar el esquema y la documentación. El explorador de documentos muestra las distintas opciones disponibles para los conjuntos de datos, las dimensiones, las operaciones y las funciones. Las palabras "zone" y "domain" son sinónimos en el explorador de documentos.

Pegue el siguiente fragmento de código de prueba en el panel de consulta y observe la respuesta en el panel de respuesta, ajustando datetime para satisfacer sus necesidades.

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

Valores de consulta para límites de cuenta

Para obtener información específica sobre los límites para un nodo de datos, utilice el nodo settings.

A continuación se muestra una consulta de ejemplo:

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

La respuesta de la consulta es la siguiente:

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

Límites de consulta

El volumen de datos que puede devolver una consulta es limitado y hay límites de usuario en el volumen de datos diario. Los límites siguientes se aplican además de los límites de velocidad generales aplicados por la API:

• Una consulta de ámbito de zona puede incluir hasta 10 zonas.
• Las consultas pueden solicitar hasta 30 campos, tal como indica maxNumberOfFields en settings.
• Las respuestas pueden devolver hasta 10.000 registros. Este límite lo indica maxPageSize en settings.

Las consultas deben especificar explícitamente el número máximo de registros que se van a devolver mediante el argumento limit.

Ejemplos de ordenación

Ordenación de datos sin formato:

firewallEventsAdaptive (orderBy: [clientCountryName_ASC]) {
    clientCountryName
}

Clasificación de datos sin formato utilizando varios campos:

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

Ordenación de grupos mediante la función de agregación:

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

Páginas de consulta sin cursores

En los siguientes ejemplos se da por supuesto que las relaciones date y clientCountryName con exclusivas.

Obtener los n primeros resultados de una consulta.

Para limitar los resultados, añada el parámetro limit. Por ejemplo, consulte los dos primeros registros.

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

La especificación de un orden de clasificación por fecha devuelve resultados menos específicos que la especificación de un orden de clasificación por fecha y por país.

La respuesta de la consulta es la siguiente:

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

Consulta de la página siguiente utilizando el filtro

Para obtener los n siguientes resultados, especifique un filtro para excluir el último resultado de la consulta anterior. Utilizando el ejemplo anterior, puede añadir el operador mayor que (_gt) al campo clientCountryName y el operador mayor o igual que al campo datetime. Creando un orden específico, se podrán obtener los resultados más completos.

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

La respuesta de la consulta es la siguiente:

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

Consultar la página anterior

Para obtener los n resultados anteriores, invierta los filtros y el orden de clasificación.

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

La respuesta de la consulta es la siguiente:

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

Estructura

El filtro GraphQL está representado por el objeto de entrada GraphQL.

Los filtros se pueden utilizar como argumento en los recursos siguientes:

• Zonas (dominios)
• Tablas (conjuntos de datos)
• Cuentas

Filtro de zona (dominio)

El filtro de zona permite consultar los datos relacionados con la zona por el ID de zona (dominio) (zoneTag).

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

El filtro de zona debe ajustarse a la siguiente gramática:

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

Los filtros compuestos (separados por comas, AND, OR) no están soportados. Las zonas siempre se ordenan alfanuméricamente.

Filtro de tabla (conjunto de datos)

Los filtros de tabla requieren que se consulte al menos un nodo. El operador AND se puede utilizar para crear y combinar filtros de varios nodos.

Filtro de cuentas

Se da soporte al filtrado a nivel de cuenta y hay un parámetro de filtro necesario. Por ejemplo:

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

Operadores

El soporte de operadores varía según el tipo de nodo y el nombre de nodo. Se da soporte a los operadores siguientes para todos los tipos:

Ejemplos

Ejemplo general:

{
  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 un nodo específico:

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

Filtrar en varios campos:

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

Filtrar utilizando el operador OR:

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