Glossário
Consulte os termos que a GraphQL API usa, de datasets, dados brutos e dados agregados a resample, tsRange, groupBy, limit e offset.
Este glossário define os termos que a GraphQL API usa nas suas queries, nos seus datasets e em toda a sua documentação.
| Termo | Definição |
|---|---|
| campo calculado | Um campo de um dataset de metrics cujo valor resulta de um cálculo, como requestsTotal ou dataTransferredTotal. Um campo calculado não aceita filtro Lte ou Gte e não pode ser a entrada de uma função de aggregate, e Campos do Real-Time Metrics marca cada um. |
| dados agregados | Os dados que os datasets do endpoint metrics retornam em intervalos de um minuto, de uma hora ou de um dia, como workloadMetrics. Uma query os resume com as funções de aggregate e com groupBy, como Queries descreve. |
| dados brutos | Os registros individuais de eventos, sem agregação, que os datasets do endpoint events retornam, como workloadEvents. Os eventos ficam disponíveis por cerca de 7 dias, como Limites da GraphQL API descreve. |
| dados de uso | Os dados de consumo de uma conta por workload, produto e métrica, que o dataset workloadConsumptionMetrics do endpoint consumption retorna. O campo accounted dele traz o valor contabilizado, como Campos de Consumption descreve. |
| dados financeiros | Os dados faturados e contabilizados de uma conta, que os datasets do endpoint billing, como billDetail, e o dataset accountingDetail do endpoint accounting retornam. Esses datasets não têm campo ts, então uma query os filtra por campos de período, como periodFrom e periodTo, conforme Queries descreve. |
| dataset | O campo de nível superior de uma query que nomeia o conjunto de registros que ela lê, como workloadMetrics ou workloadEvents. Cada endpoint atende os seus próprios datasets, e todo dataset aceita os argumentos filter, aggregate, groupBy, orderBy, offset e limit, como Datasets e argumentos de query lista. |
| GraphiQL Playground | O editor GraphiQL no navegador em que você escreve, valida e executa queries em um endpoint da GraphQL API. Cada URL de endpoint o serve a uma requisição autenticada, como GraphiQL Playground descreve. |
groupBy | O argumento de query que lista os campos cujos valores dividem o resultado em linhas, cada uma com a sua própria saída de aggregate. Ele é opcional: um aggregate sem groupBy retorna uma linha com o total, e um resample precisa de ts em groupBy, como Queries descreve. |
limit | O argumento de query que define quantas linhas uma query retorna, de 0 a 10000, com 10 como padrão. Um valor fora desse intervalo retorna um erro 400, como Limites da GraphQL API descreve. |
| metadados | As informações sobre o escopo dos dados que a GraphQL API atende: os seus datasets, os campos deles e o nome, a descrição e o tipo de cada um. Uma query de introspecção os retorna, como o guia para consultar metadados com a GraphQL API descreve. |
offset | O argumento de query que define quantas linhas uma query pula antes da primeira linha que retorna, com 0 como padrão. Com limit, ele pagina um resultado: offset: 5 com limit: 5 retorna as linhas 6 a 10, como Datasets e argumentos de query descreve. |
| operador | Um sufixo no nome de um campo dentro de filter que define como o campo é comparado a um valor, como hostLike ou statusGt. Um nome de campo sem sufixo, como host, funciona como Eq, e Datasets e argumentos de query lista os operadores que cada campo aceita. |
| query top X | Uma query que classifica os valores de um campo pela frequência com que eles ocorrem. Ela conta o campo com aggregate, agrupa por ele com groupBy, ordena por count_DESC e mantém as primeiras linhas com limit, como o guia para selecionar queries top X mostra. |
resample | O argumento de query que agrupa as linhas de um dataset de metrics em intervalos de tempo com a duração da janela dividida por points e combina cada intervalo com uma function: sum, max, min ou mean. Ele precisa de ts em groupBy, e nenhum dataset de events o aceita, como Datasets e argumentos de query descreve. |
| resolvedor adaptativo | O mecanismo que define o intervalo de tempo de cada linha que uma query agregada retorna a partir da duração da sua janela de tempo. Uma janela de até cerca de dois dias retorna intervalos de um minuto, uma janela a partir de 60 horas retorna intervalos de uma hora, e uma janela a partir de cerca de 60 dias retorna intervalos de um dia, como Limites da GraphQL API descreve. |
tsRange | O filtro que define a janela de tempo de uma query, com timestamps begin e end no mesmo fuso horário. Uma query em um dataset de metrics ou events sem janela de tempo retorna um erro 400, e tsGt ou tsLt define apenas um limite, como Datasets e argumentos de query descreve. |