Reports - List By Api

依 API 列出報表記錄。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi?$filter={$filter}&api-version=2021-01-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2021-01-01-preview

URI 參數

Name In Required Type Description
resourceGroupName
path True
  • string

資源群組的名稱。

serviceName
path True
  • string

API 管理服務的名稱。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳號憑證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

$filter
query True
  • string

要套用到作業的篩選準則。

api-version
query True
  • string

要搭配用戶端要求使用的 API 版本。

$orderby
query
  • string

OData 排序依據查詢選項。

$skip
query
  • integer
int32

要略過的記錄數目。

$top
query
  • integer
int32

要傳回的記錄數目。

回應

Name Type Description
200 OK

列出報表記錄的集合。

Other Status Codes

描述作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

ApiManagementGetReportsByApi

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byApi?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2021-01-01-preview

Sample Response

{
  "value": [
    {
      "name": "Echo API",
      "apiId": "/apis/5600b59475ff190048040001",
      "callCountSuccess": 0,
      "callCountBlocked": 0,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 0,
      "bandwidth": 0,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 0,
      "apiTimeMin": 0,
      "apiTimeMax": 0,
      "serviceTimeAvg": 0,
      "serviceTimeMin": 0,
      "serviceTimeMax": 0
    },
    {
      "name": "httpbin",
      "apiId": "/apis/57a03a13e4bbd5119c8b19e9",
      "callCountSuccess": 13,
      "callCountBlocked": 1,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 14,
      "bandwidth": 11019,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 1015.7607923076923,
      "apiTimeMin": 330.3206,
      "apiTimeMax": 1819.2173,
      "serviceTimeAvg": 957.094776923077,
      "serviceTimeMin": 215.24,
      "serviceTimeMax": 1697.3612
    }
  ],
  "count": 2,
  "nextLink": ""
}

定義

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

ReportCollection

分頁報表記錄清單表示。

ReportRecordContract

報表資料。

ErrorFieldContract

錯誤欄位合約。

Name Type Description
code
  • string

屬性層級錯誤碼。

message
  • string

人們可讀取的屬性層級錯誤標記法。

target
  • string

屬性名稱。

ErrorResponse

錯誤回應。

Name Type Description
error.code
  • string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

如果發生驗證錯誤,則為不正確欄位清單會送出要求。

error.message
  • string

錯誤的人們可讀取標記法。

ReportCollection

分頁報表記錄清單表示。

Name Type Description
count
  • integer

所有頁面上的記錄計數總數。

nextLink
  • string

下一頁連結(如果有的話)。

value

頁面值。

ReportRecordContract

報表資料。

Name Type Description
apiId
  • string

API 識別碼路徑。 /apis/{apiId}

apiRegion
  • string

API 地區識別碼。

apiTimeAvg
  • number

處理要求所花費的平均時間。

apiTimeMax
  • number

處理要求所花費的時間上限。

apiTimeMin
  • number

處理要求所花費的最短時間。

bandwidth
  • integer

耗用的頻寬。

cacheHitCount
  • integer

從快取原則提供內容的次數。

cacheMissCount
  • integer

從後端提取內容的次數。

callCountBlocked
  • integer

由於認證無效而封鎖的呼叫次數。 這包括傳回 HttpStatusCode 的呼叫,以及 HttpStatusCode. 禁止和 HttpStatusCode。 TooManyRequests

callCountFailed
  • integer

由於 Proxy 或後端錯誤而失敗的呼叫次數。 這包括傳回 HttpStatusCode. BadRequest (400) 和 HttpStatusCode) InternalServerError (500 和600之間的任何程式碼。

callCountOther
  • integer

其他呼叫的數目。

callCountSuccess
  • integer

成功的呼叫數。 這包括傳回 HttpStatusCode <= 301 和 HttpStatusCode. NotModified 和 HttpStatusCode. TemporaryRedirect 的呼叫。

callCountTotal
  • integer

呼叫總數。

country
  • string

與此記錄資料相關的國家/地區。

interval
  • string

匯總期間的長度。 間隔必須是15分鐘的倍數,且不得為零。 此值應為 ISO 8601 格式的 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。

name
  • string

根據報表端點指定的名稱會指定產品、API、作業或開發人員名稱。

operationId
  • string

操作識別碼路徑。 /apis/{apiId}/operations/{operationId}

productId
  • string

產品識別碼路徑。 /products/{productId}

region
  • string

與此記錄資料相關的國家/地區。

serviceTimeAvg
  • number

在後端處理要求所花費的平均時間。

serviceTimeMax
  • number

在後端處理要求所花費的時間上限。

serviceTimeMin
  • number

在後端處理要求所花費的最短時間。

subscriptionId
  • string

訂用帳戶識別碼路徑。 /subscriptions/{subscriptionId}

timestamp
  • string

匯總期間的開始。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。

userId
  • string

使用者識別碼路徑。 /users/{userId}

zip
  • string

與此記錄資料相關的郵遞區號。