您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
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：URI 參數，用於定義要擷取 API 平台指標的實體。Apigee 定義了一組可用於報表的維度。支援的維度包括：
/stats/apis：API 平台上的機構 API Proxy/stats/apiproducts：機構中定義的 API 產品/stats/apps：向 API 發出要求的開發人員應用程式名稱/stats/client_ip：向 API 平台上的 API 發出要求的應用程式 IP 位址/stats/developer_email：API 平台中已在機構註冊的開發人員電子郵件地址/stats/developer_app：向 API 發出要求的開發人員應用程式名稱/stats/devs：在 API Platform 上的機構中註冊的專屬 Edge 產生開發人員 ID/stats/access_token：應用程式使用者 OAuth 存取權杖
篩選器可套用至自訂資源。自訂資源包括：
| 符號 | 作業 |
|---|---|
in |
納入清單 |
notin |
排除清單 |
eq |
= |
ne |
!= 或 |
gt |
> |
lt |
|
ge |
>= |
le |
| 說明 | 篩選查詢結構 |
|---|---|
| 名為 api1 或 api2 的 API Proxy 統計資料 | filter=(apiproxy in 'api1','api2') |
| api1 和 api2 以外的所有 API Proxy 的統計資料 | 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 | N/A | 是 |
| timeRange | 所需時間間隔的開始和結束時間。日期格式為 MM/DD/YYYY HH:MM。 例如 1/1/2013%2000:00~1/2/2013%2000:00。時間範圍上限為 6 個月 | N/A | 是 |
| timeUnit | 秒、分、時、日、週、月、季、年、十年、世紀、千禧年 | N/A | 是 |
| sortby | 指定兩個以上的選取值時，可以使用「sortby」指定用於排序結果的選取值：message_count、error_count、total_response_time、max_response_time、min_response_time、data_exchange_size、end_point_response_time | N/A | 否 |
| 排序 | 支援的排序範圍為 DESC 或 ASC | N/A | 否 |
| topk | 從結果中取得「前 k」個結果，例如傳回前 5 個結果「topk=5」。 | N/A | 否 |
| 篩選器 | 可針對特定維度值進行細查 | N/A | 否 |
| 限制 | 設定 API 傳回的項目數量上限 | N/A | 否 |
| 碳補償 | 使用偏移和限制來啟用結果分頁。舉例來說，如要顯示第 11 到 20 個結果，請將限制設為「10」，並將偏移量設為「10」。 | N/A | 否 |
{
"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。 |
| 指標 | 報表指標 |