Glossário
Consulte os termos que a Azion API usa, de personal tokens e caminhos do workspace a paginação, seleção de campos e headers de rate limit.
Este glossário define os termos que a Azion API usa nos seus caminhos, nos seus parâmetros de query e nos seus headers de resposta.
| Termo | Definição |
|---|---|
| API v4 | A versão da Azion API servida em https://api.azion.com/v4, que as páginas da Azion API documentam. Uma conta passa da API v3 para ela pela Migração para API v4, e Verifique a versão da API da sua conta mostra como verificar uma conta. |
| escopo do rate limit | O header de resposta X-RateLimit-Scope, que toda resposta autenticada da Azion API traz com o valor global-default. Ele vem com X-RateLimit-Limit definido como 200, X-RateLimit-Remaining e X-RateLimit-Reset, como Azion API descreve. |
fields | Um parâmetro de query que recebe uma lista, separada por vírgulas, dos nomes dos campos a incluir na resposta. Em uma lista, fields=id,name retorna cada resultado apenas com o id e o name. As operações de listagem e de leitura o aceitam, e os campos aninhados usam notação de ponto, como a referência da Azion API descreve. |
ordering | Um parâmetro de query que indica o campo que ordena uma lista, como ordering=name. Um - antes do nome do campo ordena a lista em ordem decrescente, como em ordering=-id. As operações de listagem o aceitam, como a referência da Azion API descreve. |
page | Um parâmetro de query que escolhe uma página de uma lista, contada a partir de 1. As operações de listagem o aceitam, como a referência da Azion API descreve. A resposta da lista informa o número de páginas em total_pages, e uma página depois da última retorna 404. |
page_size | Um parâmetro de query que define quantos resultados uma página de uma lista contém, 10 por padrão e 100 no máximo, como Azion API descreve. Um valor acima de 100 retorna 400. |
| personal token | A credencial que autentica as suas chamadas à Azion API e os seus comandos da Azion CLI, mostrada apenas uma vez, quando você a cria. A API lê essa credencial do header Authorization como Token [TOKEN VALUE] e também aceita o prefixo Bearer. Gerencie personal tokens cria e revoga personal tokens. |
search | Um parâmetro de query que recebe um termo de busca, segundo a referência da Azion API, e restringe uma lista aos resultados correspondentes. Em GET /v4/workspace/workloads, search=astro retorna os workloads cujos nomes contêm astro. |
workspace | O segmento de caminho que contém os endpoints de recursos da Azion API v4, como /v4/workspace/workloads e /v4/workspace/network_lists. As operações de autenticação ficam em /v4/account/, fora dele. Primeiros passos com a Azion API chama esses dois caminhos do workspace. |