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

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
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: İNDİRİN
Yetkilendirme: Temel Kimlik Doğrulama
Medya türleri:
application/json
Genel bakış: Rapor, /stats API'de GET isteği kullanılarak oluşturulur aşağıdaki bilgilerle birlikte gösterilen kaynak:
  • Raporun boyutunu tanımlayan isteğe bağlı bir URI parametresi. Apigee, Söz konusu boyut, bir metrik grubunu bu boyutlara göre önceden toplar. Hiçbir boyut tanımlı (ör. URI parametresi boşsa) tüm API'ler için bir rapor oluşturulur belirtilen ortamda bulunması gerekir.
  • Metrikleri, zaman aralığını, zaman aralığını ve ayrıntılarını inceleyeceğiz.

dimension_name: API'nin ilişkili olduğu varlığı tanımlayan URI parametresi Platform metriklerinin alınması gerekir. Apigee, raporlar. Desteklenen boyutlar şunlardır:

  • /stats/apis: API Platformu'ndaki bir kuruluştaki 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'de API'lere istekte bulunan uygulamaların IP adresleri Platform
  • /stats/developer_email: Google Play'de kayıtlı bir geliştiricinin e-posta adresi API Platformu üzerindeki kuruluş
  • /stats/developer_app: İstekte bulunan geliştirici uygulamasının adı API'niz
  • /stats/devs: API Platformu üzerindeki kuruluş
  • /stats/access_token: Uygulama son kullanıcısının OAuth erişim jetonu
Filtreleme

Filtreler özel kaynaklara uygulanabilir. Özel kaynaklar:

Sembol İşlem
in liste eklemek için
notin liste hariç tutma için
eq =
ne != veya
gt >
lt
ge >=
le
Örnek filtreler
Açıklama Filtre sorgu yapısı
api1 veya api2 adlı API proxy'leriyle ilgili istatistikler filter=(apiproxy in 'api1','api2')
api1 ve api2 dışındaki tüm API proxy'leri için istatistikler filter=(apiproxy notin 'ap1','api2')
Hata olmayan istatistikler filter=(iserror eq 0)
Hata mesajı olmayan veya API proxy adının api1 ya da api2 olduğu istatistikler filter=(iserror eq 1) or (apiproxy in 'api1','api2')
(Yanıt kodunun 201 veya 301 olduğu) ve (hatalar var) veya (API proxy'si) ile ilgili istatistikler ad api1 veya api2'dir) 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ç Rapor için toplanacak metriği belirtir. Desteklenen metrikler: Message_count, error_count, total_response_time, max_response_time, min_response_time, veri_exchange_boyutu, bitiş_noktası_yanıt_zamanı 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, milenyum Yok Evet
Sortby İki veya daha fazla seçim değeri belirtildiğinde "sıralama" kullanılabildiğini belirtmek için sonuçları sıralamak için kullanılanlardan birini seçin: 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 "İlk k"yı al sonuçlardan sonuç (ör. ilk 5 sonucu döndürmek için) "topk=5" gibi sorgu karakterleri oluşturabilirsiniz. Yok Hayır
filtrele Belirli boyut değerlerinde ayrıntılı incelemeyi etkinleştirir Yok Hayır
sınır API tarafından döndürülen giriş sayısı sınırını belirleyin Yok Hayır
telafi etmek Sonuçların sayfalara ayrılmasını etkinleştirmek için sınır ile ofset kullanın. Örneğin, sonuçları görmek için 11-20, sınırı "10" olarak ayarlayın ve '10'a uzaklığıdır. 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
meta veri Raporla ilişkili meta veriler
ortamlar Kuruluşta istatistiklerin toplandığı ortamlar (joker karakter desteklenir) * ortamlar arası istatistikleri toplama için kullanılır)
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