Esta é a documentação do Apigee Edge.
Acesse
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: | RECEBER |
| Autenticação: | Autenticação básica |
| Tipos de mídia: |
aplicativo/json
|
Visão geral:um relatório é gerado usando uma solicitação GET na API
/stats.
, acompanhado de:
- Um parâmetro URI opcional que define a dimensão do relatório. A Apigee define um conjunto e agrega um conjunto de métricas com base nessas dimensões. Se nenhuma dimensão for definido (isto é, 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 define as métricas, o período, o intervalo de tempo e filtrar/detalhar aspectos do relatório.
dimension_name: um parâmetro de URI que define a entidade para a qual a API
As métricas de plataforma devem ser recuperadas. A Apigee define um conjunto de dimensões que podem ser usadas
e detecção de ameaças. As dimensões compatíveis incluem:
/stats/apis: proxies de API em uma organização na plataforma de API/stats/apiproducts: produtos de API definidos em uma organização/stats/apps: o nome do app do desenvolvedor que faz a solicitação à API/stats/client_ip: endereços IP dos apps que fazem a solicitação para APIs na API. Plataforma/stats/developer_email: o endereço de e-mail de um desenvolvedor registrado em um organização na Plataforma de APIs/stats/developer_app: o nome do app do desenvolvedor que faz a solicitação de sua API/stats/devs:o ID exclusivo do desenvolvedor gerado pelo Edge e registrado em um organização na Plataforma de APIs/stats/access_token: o token de acesso de OAuth do usuário final do app.
É possível aplicar filtros a recursos personalizados. Os recursos personalizados são:
| Símbolo | Operação |
|---|---|
in |
para inclusão em listas |
notin |
para exclusão de lista |
eq |
= |
ne |
!= ou |
gt |
> |
lt |
|
ge |
>= |
le |
| Descrição | Filtrar estrutura da consulta |
|---|---|
| Estatísticas para proxies de API chamados api1 ou api2 | filter=(apiproxy in 'api1','api2') |
| Estatísticas de todos os proxies de API, exceto api1 e api2 | filter=(apiproxy notin 'ap1','api2') |
| Estatísticas sem 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 (proxy de API) o nome é 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_exchange_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 |
| Sortby | Quando dois ou mais valores de seleção são especificados, 'sortby' pode ser usado para especificar select usado para classificar resultados: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_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 "top k" resultados dos resultados, por exemplo, para retornar os cinco principais resultados "topk=5". | N/A | Não |
| filtro | Ativa o detalhamento de valores de dimensões específicas | N/A | Não |
| limite | Definir o limite para o número de entradas retornadas pela API | N/A | Não |
| offset | Use o deslocamento com limite para ativar a paginação dos resultados. Por exemplo, para exibir resultados 11 a 20, definir limite como "10" e o deslocamento para "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" : {
}
}| Nome | Descrição |
|---|---|
| metadados | Metadados associados ao relatório. |
| environments | Ambientes na organização em que as estatísticas são coletadas (oferece suporte a caracteres * para coleta de estatísticas entre ambientes) |
| métricas | Os valores retornados para a dimensão especificada |
| dimensões | A dimensão definida para medição: neste exemplo, api_name. |
| métricas | Métricas do relatório |