擷取及篩選 Apigee Analytics 服務中的維度指標

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

API 平台基礎路徑： https://api.enterprise.apigee.com/v1/o/{org_name}

API 資源路徑： /environments/{env_name}/stats/{dimension_name}

說明：使用 GET 方法擷取維度的指標

動詞： 下載
驗證： 基本驗證
媒體類型：
application/json
總覽：在 /stats API 上使用 GET 要求會產生報表 資源，搭配者：
  • 選用 URI 參數，定義報表維度。Apigee 會定義一組 然後根據這些維度預先匯總一組指標。如果沒有維度 定義 (也就是說，如果 URI 參數空白)，系統會針對所有 API 產生報表 建立容器
  • 一組查詢參數，定義指標、時間範圍、時間間隔和 報表的篩選/細查部分

dimension_name：定義 API 所屬實體的 URI 參數 應擷取平台指標。Apigee 定義了一組維度，可用於 報表。支援的維度包括：

  • /stats/apis：API 平台中機構的 API Proxy
  • /stats/apiproducts：機構中定義的 API 產品
  • /stats/apps：對 API 提出要求的開發人員應用程式名稱
  • /stats/client_ip：向 API 發出要求的應用程式所在的 IP 位址 平台
  • /stats/developer_email：在 API 平台上的組織架構
  • /stats/developer_app：提出要求的開發人員應用程式名稱 您的 API
  • /stats/devs：在 API 平台上的組織架構
  • /stats/access_token：應用程式使用者的 OAuth 存取權杖
篩選

篩選器可套用至自訂資源。自訂資源是：

符號 作業
in 表示納入清單
notin 表示排除名單
eq =
ne != 或
gt >
lt
ge >=
le
篩選器範例
說明 篩選查詢結構
名為 api1 或 api2 的 API Proxy 統計資料 filter=(apiproxy in 'api1','api2')
所有 API Proxy 的統計資料 (api1 和 api2 除外) filter=(apiproxy notin 'ap1','api2')
沒有錯誤的統計資料 filter=(iserror eq 0)
沒有錯誤訊息或 API Proxy 名稱為 api1 或 api2 的統計資料 filter=(iserror eq 1) or (apiproxy in 'api1','api2')
統計資料，其中 (回應代碼為 201 或 301) 和 (出現錯誤) 或 (API Proxy) 名稱為 api1 或 api2) filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

要求範例：

$ 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
查詢參數：
名稱 說明 預設 必填與否
選取 指定要在報表中匯總的指標。支援的指標為 message_count、error_count、total_response_time、max_response_time、min_response_time、 data_Exchange_size、end_point_response_time 不適用 是
timeRange 所需間隔的開始和結束時間。日期格式為 MM/DD/YYYY HH:MM， 例如：1/1/2013%2000:00~1/2/2013%2000:00。最長的時間範圍為 6 個月 不適用 是
timeUnit 秒、分鐘、小時、日、週、月、季、年、十年、世紀、千禧世代 不適用 是
排序 指定兩個以上的選取值時，「排序」即可用於指定 用於將結果排序，選項如下：message_count、error_count、total_response_time、 max_response_time、min_response_time、data_Exchange_size、end_point_response_time 不適用 否
排序 支援的排序範圍為 DESC 或 ASC 不適用 否
Topk 以「前 K 個」為準例如傳回前 5 筆結果 "topk=5"。 不適用 否
篩選器 啟用細查特定維度值的功能 不適用 否
限制 設定 API 傳回的項目數量上限 不適用 否
碳補償 使用偏移量搭配限制，啟用結果分頁。例如： 11 至 20，將限制設為「10」並將偏移量設為「10」 不適用 否
回應範例： 
{
  "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" : {
    }
}
回應酬載元素：
名稱 說明
中繼資料 與報表相關聯的中繼資料
environments 組織中收集統計資料的環境 (支援萬用字元 * 用於跨環境統計資料收集)
指標 針對指定維度傳回的值
尺寸 用於評估的維度：在此範例中為 api_name。
指標 報表指標