Consulte os metadados do schema GraphQL

Liste os datasets que um endpoint da GraphQL API atende, os campos de cada dataset e os seus tipos com uma query de introspecção.

Última atualização

Ver como Markdown Configurar agente

Você pode perguntar à GraphQL API quais datasets um endpoint atende, quais campos cada dataset retorna e o tipo de cada campo. A resposta vem de uma query de introspecção, que lê o schema em vez dos seus dados. Use-a para conferir o nome de um dataset ou de um campo antes de escrever uma query.

Pré-requisitos

Liste os datasets e os seus campos

Cada endpoint descreve apenas os próprios datasets. Os passos abaixo consultam https://api.azion.com/v4/metrics/graphql, que atende os datasets de métricas. Para listar os datasets de outro endpoint, como https://api.azion.com/v4/events/graphql, envie as mesmas queries para ele.

Para ler o schema do endpoint de métricas:

Envie a query de introspecção

Envie esta query em uma requisição POST para https://api.azion.com/v4/metrics/graphql, com o header Authorization: Token [TOKEN VALUE]. Para enviar uma query, consulte Primeiros passos com a GraphQL API ou Execute queries GraphQL no Postman.

GraphQL
01query introspectionQuery {
02 __type(name: "Query") {
03 name
04 description
05 fields {
06 name
07 description
08 type {
09 ofType {
10 fields {
11 name
12 type {
13 name
14 }
15 }
16 }
17 }
18 }
19 }
20}
Confira os datasets na resposta

A API responde com HTTP 200 e uma entrada por dataset em fields. A resposta abaixo está cortada depois do terceiro dataset e depois do terceiro campo de cada dataset:

JSON
01{
02 "data": {
03 "__type": {
04 "name": "Query",
05 "description": null,
06 "fields": [
07 {
08 "name": "realTimeEventsQueriesMetrics",
09 "description": "Real-Time Events Metrics dataset query by Minute, Hour and Day with aggregate options.",
10 "type": {
11 "ofType": {
12 "fields": [
13 {
14 "name": "ts",
15 "type": {
16 "name": "CustomDateTime"
17 }
18 },
19 {
20 "name": "sourceLocPop",
21 "type": {
22 "name": "String"
23 }
24 },
25 {
26 "name": "configurationId",
27 "type": {
28 "name": "Int"
29 }
30 },
31 …
32 ]
33 }
34 }
35 },
36 {
37 "name": "aiMetrics",
38 "description": "Query AI Metrics with aggregate options.",
39 "type": {
40 "ofType": {
41 "fields": [
42 {
43 "name": "ts",
44 "type": {
45 "name": "CustomDateTime"
46 }
47 },
48 {
49 "name": "sourceLocPop",
50 "type": {
51 "name": "String"
52 }
53 },
54 {
55 "name": "configurationId",
56 "type": {
57 "name": "Int"
58 }
59 },
60 …
61 ]
62 }
63 }
64 },
65 {
66 "name": "objectStorageMetrics",
67 "description": "Object Storage Metrics dataset query by Day with aggregate options.",
68 "type": {
69 "ofType": {
70 "fields": [
71 {
72 "name": "ts",
73 "type": {
74 "name": "CustomDateTime"
75 }
76 },
77 {
78 "name": "location",
79 "type": {
80 "name": "String"
81 }
82 },
83 {
84 "name": "bucketId",
85 "type": {
86 "name": "String"
87 }
88 },
89 …
90 ]
91 }
92 }
93 },
94 …
95 ]
96 }
97 }
98}
Liste os datasets descontinuados

A primeira query deixa de fora os datasets descontinuados, como httpMetrics, que workloadMetrics substitui. Para listar todos os datasets com o status de descontinuação de cada um, envie esta query para o mesmo endpoint:

GraphQL
01query {
02 __type(name: "Query") {
03 fields(includeDeprecated: true) { name isDeprecated deprecationReason }
04 }
05}

A API responde com HTTP 200. A resposta abaixo está cortada depois do terceiro dataset:

JSON
01{
02 "data": {
03 "__type": {
04 "fields": [
05 {
06 "name": "realTimeEventsQueriesMetrics",
07 "isDeprecated": false,
08 "deprecationReason": null
09 },
10 {
11 "name": "aiMetrics",
12 "isDeprecated": false,
13 "deprecationReason": null
14 },
15 {
16 "name": "edgeAIMetrics",
17 "isDeprecated": true,
18 "deprecationReason": "Use aiMetrics instead."
19 },
20 …
21 ]
22 }
23 }
24}

Você tem o nome, a descrição e a lista de campos de cada dataset que o endpoint atende, e o substituto de cada dataset descontinuado.

Leia a resposta

Cada chave das duas respostas descreve uma parte do schema:

ChaveO que contém
nameQuery, o tipo raiz que contém todos os datasets do endpoint.
descriptionA descrição do tipo raiz. O valor é null.
fields[].nameO nome de um dataset, o nome que você coloca em uma query.
fields[].descriptionO que o dataset contém. A maioria das descrições também indica os buckets de tempo em que o dataset agrupa os dados, como minuto, hora e dia.
fields[].type.ofType.fieldsOs campos que o dataset retorna, cada um com o seu name e o nome do seu tipo.
type.name de um campoO tipo do valor do campo, como CustomDateTime para ts, String ou Int.
isDeprecated e deprecationReasonSe um dataset está descontinuado e, quando está, o dataset a usar no lugar dele.

Próximos passos

Datasets e argumentos de queryVeja todos os datasets por endpoint e os argumentos que cada query aceita.Campos do Real-Time MetricsLeia o que cada campo dos datasets de métricas retorna.Campos do Real-Time EventsLeia o que cada campo dos datasets de eventos retorna.QueriesEscreva queries brutas, agregadas, financeiras e de uso com os nomes que você encontrou.