Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Caminho base da plataforma de API:
https://api.enterprise.apigee.com/v1/o/{org_name}
Caminho do recurso da API: /environments/{env_name}/stats/{dimension_name}
Descrição:use o método GET para recuperar métricas de uma dimensão
| Verbo: | GET |
| Auth: | Autenticação básica |
| Tipos de mídia: |
application/json
|
Visão geral: um relatório é gerado usando uma solicitação GET no recurso da API
/stats, acompanhado por:
- Um parâmetro de URI opcional que define a dimensão do relatório. A Apigee define um conjunto de dimensões e agrega um conjunto de métricas com base nessas dimensões. Se nenhuma dimensão for definida (ou seja, se o parâmetro de URI estiver vazio), um relatório será gerado para todas as APIs presentes no ambiente especificado.
- Um conjunto de parâmetros de consulta que definem as métricas, o período, o intervalo de tempo e os aspectos de filtro/detalhamento do relatório.
dimension_name: um parâmetro de URI que define a entidade em que as métricas da plataforma da API precisam ser recuperadas. A Apigee define um conjunto de dimensões que podem ser usadas nos
relatórios. As dimensões compatíveis incluem:
/stats/apis: proxies de API em uma organização na plataforma de APIs/stats/apiproducts: produtos de API definidos em uma organização/stats/apps: o nome do app do desenvolvedor que fez a solicitação à API/stats/client_ip: endereços IP dos apps que fazem a solicitação às APIs na plataforma de APIs./stats/developer_email: o endereço de e-mail de um desenvolvedor registrado em uma organização na plataforma de APIs/stats/developer_app: o nome do app do desenvolvedor que faz a solicitação à sua API/stats/devs:o ID do desenvolvedor exclusivo gerado pelo Edge registrado em uma organização na plataforma de APIs/stats/access_token: o token de acesso OAuth do usuário final do app
Os filtros podem ser aplicados a recursos personalizados. Os recursos personalizados são:
| Símbolo | Operação |
|---|---|
in |
para inclusão na lista |
notin |
para exclusão de listas |
eq |
= |
ne |
!= ou |
gt |
> |
lt |
|
ge |
>= |
le |
| Descrição | Filtrar estrutura da consulta |
|---|---|
| Estatísticas para proxies de API com o nome api1 ou api2 | filter=(apiproxy in 'api1','api2') |
| Estatísticas para todos os proxies de API, exceto api1 e api2 | filter=(apiproxy notin 'ap1','api2') |
| Estatísticas em que não há erros | filter=(iserror eq 0) |
| Estatísticas em que não há mensagens de erro ou o nome do proxy da API é api1 ou api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| Estatísticas em que (o código de resposta é 201 ou 301) e (há erros) ou (o nome do proxy de API é api1 ou api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
Exemplo de solicitação:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| Nome | Descrição | Padrão | Obrigatório? |
|---|---|---|---|
| select | Designa a métrica a ser agregada para o relatório. As métricas aceitas são message_count, error_count, total_response_time, max_response_time, min_response_time, data_swap_size, end_point_response_time | N/A | Sim |
| timeRange | Os horários de início e término do intervalo desejado. O formato da data é MM/DD/AAAA HH:MM. Por exemplo, 1/1/2013%2000:00~1/2/2013%2000:00. O período máximo é de seis meses | N/A | Sim |
| timeUnit | segundo, minuto, hora, dia, semana, mês, trimestre, ano, década, século, milênio | N/A | Sim |
| classificar por | Quando dois ou mais valores de seleção são especificados, "sortby" pode ser usado para especificar a seleção usada para classificar resultados: message_count, error_count, total_response_time, max_response_time, min_response_time, data_swap_size, end_point_response_time | N/A | Não |
| sort | Os escopos de classificação compatíveis são DESC ou ASC | N/A | Não |
| topk | Pegue os resultados "top k" dos resultados, por exemplo, para retornar os cinco principais resultados "topk=5". | N/A | Não |
| Função filter | Ativa o detalhamento de valores de dimensões específicos | N/A | Não |
| limite | Definir o limite para o número de entradas retornadas pela API | N/A | Não |
| offset | Use deslocamento com limite para ativar a paginação dos resultados. Por exemplo, para exibir os resultados de 11 a 20, defina o limite como "10" e o deslocamento como "10". | N/A | Não |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}
Elementos de payload de resposta:
| Nome | Descrição |
|---|---|
| metadados | Metadados associados ao relatório |
| environments | Ambientes na organização em que as estatísticas são coletadas (aceita o caractere curinga * para a coleta de estatísticas em vários ambientes) |
| metrics | Os valores retornados para a dimensão especificada |
| dimensions | A dimensão definida para medição: neste exemplo, "api_name". |
| metrics | Métricas do relatório |