Apigee Analytics hizmetlerinden bir boyut için metrikleri alma ve filtreleme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

API Platformu Temel Yolu: https://api.enterprise.apigee.com/v1/o/{org_name}

API Kaynak Yolu: /environments/{env_name}/stats/{dimension_name}

Açıklama: Bir boyuta ilişkin metrikleri almak için GET yöntemini kullanma

Fiil: GET
Auth: Temel Kimlik Doğrulama
Medya türleri:
application/json
Genel bakış: /stats API kaynağında GET isteği kullanılarak bir rapor ve şu bilgilerle birlikte oluşturulur:
  • Raporun boyutunu tanımlayan isteğe bağlı bir URI parametresi. Apigee, boyutları tanımlar ve bu boyutlara göre bir dizi metriği önceden toplar. Hiçbir boyut tanımlanmamışsa (ör. URI parametresi boşsa) belirtilen ortamda bulunan tüm API'ler için bir rapor oluşturulur.
  • Raporun metriklerini, zaman aralığını, zaman aralığını ve filtreleme/ayrıntılı inceleme özelliklerini tanımlayan bir sorgu parametreleri grubu.

dimension_name: API Platform metriklerinin alınması gereken varlığı tanımlayan bir URI parametresidir. Apigee, raporlarda kullanılabilecek bir dizi boyut tanımlar. Desteklenen boyutlar şunlardır:

  • /stats/apis: API Platformu'ndaki bir kuruluşta API proxy'leri
  • /stats/apiproducts: Bir kuruluşta tanımlanan API ürünleri
  • /stats/apps: API'nize istekte bulunan geliştirici uygulamasının adı
  • /stats/client_ip: API Platformu'ndaki API'lere istekte bulunan uygulamaların IP adresleri
  • /stats/developer_email: API Platformu'ndaki bir kuruluşa kayıtlı bir geliştiricinin e-posta adresi
  • /stats/developer_app: API'nize istekte bulunan geliştirici uygulamasının adı
  • /stats/devs:API Platformu'ndaki bir kuruluşta kayıtlı, Edge tarafından oluşturulan benzersiz geliştirici kimliği
  • /stats/access_token: Uygulama son kullanıcısının OAuth erişim jetonu
Filtreleme

Özel kaynaklara filtreler uygulanabilir. Özel kaynaklar:

Sembol İşlem
in listeye dahil edilmesi için
notin liste hariç tutma işlemi için
eq =
ne != veya
gt >
lt
ge >=
le
Örnek filtreler
Açıklama Filtre sorgu yapısı
api1 veya api2 adlı API proxy'leri için istatistikler filter=(apiproxy in 'api1','api2')
api1 ve api2 hariç tüm API proxy'leri için istatistikler filter=(apiproxy notin 'ap1','api2')
Hata bulunmayan istatistikler filter=(iserror eq 0)
Hata mesajı bulunmayan veya API proxy adının api1 ya da api2 olduğu istatistikler filter=(iserror eq 1) or (apiproxy in 'api1','api2')
(Yanıt kodu 201 veya 301 olduğunda) ve (hatalar var) veya (API proxy adı api1 veya api2 olduğunda) istatistikler filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

Örnek İstek:

$ 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
Sorgu Parametreleri:
Ad Açıklama Varsayılan Zorunlu mu?
seçer Rapor için toplanacak metriği belirtir. Desteklenen metrikler şunlardır: message_count, error_count, total_response_time, max__Response_time, min__Response_time, data_exchange_size, end_point_response_time Yok Evet
timeRange İstenen aralığın başlangıç ve bitiş zamanı. Tarih biçimi AA/GG/YYYY SS:DD şeklindedir. Örneğin, 1/1/2013%2000:00~1/2/2013%2000:00. Maksimum zaman aralığı 6 aydır Yok Evet
timeUnit saniye, dakika, saat, gün, hafta, ay, çeyrek, yıl, on yıl, yüzyıl, milenyum Yok Evet
Sortby İki veya daha fazla seçili değer belirtildiğinde, sonuçları sıralamak için kullanılan seçimi belirtmek üzere "siralama" özelliği kullanılabilir: message_count, error_count, total_response_time, max_Response_time, min_Response_time, data_exchange_size, end_point_Response_time Yok Hayır
sıralama Desteklenen sıralama kapsamları: DESC veya ASC Yok Hayır
topk Örneğin, sonuçlardan "ilk k"yi alarak en iyi 5 sonucu döndürmek için "topk=5" değerini kullanın. Yok Hayır
filter Belirli boyut değerlerinin ayrıntısına inmeyi etkinleştirir Yok Hayır
sınır API tarafından döndürülen giriş sayısı için sınır belirleyin Yok Hayır
ofset Sonuçların sayfalara ayrılmasını sağlamak için limitli ofset kullanın. Örneğin, 11-20 arasındaki sonuçları görüntülemek için sınırı "10" ve ofseti "10" olarak ayarlayın. Yok Hayır
Örnek Yanıt: 
{
  "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" : {
    }
}
Yanıt Yük Öğeleri:
Ad Açıklama
metadata Raporla ilişkili meta veriler
ortamlar Kuruluşta istatistiklerin toplandığı ortamlar (ortamlar arası istatistik toplama için * joker karakterini destekler)
metrics Belirtilen boyut için döndürülen değerler
boyutlar Ölçüm için tanımlanan boyut: Bu örnekte api_name.
metrics Rapora ilişkin metrikler