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

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

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

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

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

動詞： 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 平台機構中註冊的 Edge 產生的專屬開發人員 ID
  • /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 秒, 分鐘, 小時, 日, 週,月, 季, 年, 年, 00 年, 千禧年, 千年 不適用 是
排序依據 指定兩個以上的選取值時，您可以使用「sortby」來指定排序結果時使用的選取項目：message_count、error_count、total_response_time、max_response_time、min_response_time、data_exchange_size、end_point_response_time 不適用 否
排序 支援的排序範圍為 DESC 或 ASC 不適用 否
頂端 舉例來說，以「前 k 名」結果為例，傳回前 5 筆結果「topk=5」。 不適用 否
過濾器 啟用細查特定維度值 不適用 否
限制 設定 API 傳回的項目數量上限 不適用 否
碳補償 使用設有限制的 offset 以啟用結果分頁。舉例來說，如要顯示 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 收集這些統計資料的環境 (支援萬用字元 * 用於跨環境統計資料收集作業)
metrics 針對指定維度傳回的值
維度 為測量定義的維度：在此範例 api_name 中。
metrics 報表指標