你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Reports - List By Subscription

按订阅列出报表记录。

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

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

$filter
query True

string

|字段 |使用情况 |支持的运算符 |支持的函数 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | | |
| displayName | select, orderBy | |
|apiRegion |filter |eq | |
| userId | select,filter | eq | |
|productId |选择、筛选 |eq | |
| subscriptionId | select, filter | eq | |
| |callCountSuccess |select, orderBy | | |
| callCountBlocked | select, orderBy | |
| |callCountFailed |select, orderBy | | |
| callCountOther | select, orderBy | |
| |callCountTotal |select, orderBy | | |
| 带宽 | select, orderBy | |
| |cacheHitsCount |选择 | | | |
| cacheMissCount | select | | |
|apiTimeAvg |select, orderBy | | |
| apiTimeMin | select | | |
|apiTimeMax |选择 | | | |
| serviceTimeAvg | select | | |
|serviceTimeMin |选择 | | | |
| serviceTimeMax | select | | |

api-version
query True

string

要用于此操作的 API 版本。

$orderby
query

string

OData 按查询排序选项。

$skip
query

integer

int32

要跳过的记录数。

$top
query

integer

int32

要返回的记录数。

响应

名称 类型 说明
200 OK

ReportCollection

列出报表记录的集合。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetReportsBySubscription

示例请求

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

示例响应

{
  "value": [
    {
      "name": "",
      "userId": "/users/1",
      "productId": "/products/5600b59475ff190048060001",
      "subscriptionId": "/subscriptions/5600b59475ff190048070001",
      "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": "",
      "userId": "/users/1",
      "productId": "/products/5600b59475ff190048060002",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "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
    },
    {
      "name": "",
      "userId": "/users/1",
      "productId": "/products/5702e97e5157a50f48dce801",
      "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303",
      "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
    }
  ],
  "count": 3,
  "nextLink": ""
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

ReportCollection

分页报表记录列表表示形式。

ReportRecordContract

报表数据。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

ReportCollection

分页报表记录列表表示形式。

名称 类型 说明
count

integer

所有页面的总记录计数数。

nextLink

string

下一页链接(如果有)。

value

ReportRecordContract[]

页面值。

ReportRecordContract

报表数据。

名称 类型 说明
apiId

string

API 标识符路径。 /apis/{apiId}

apiRegion

string

API 区域标识符。

apiTimeAvg

number

处理请求所花费的平均时间。

apiTimeMax

number

处理请求所花费的最长时间。

apiTimeMin

number

处理请求所花费的最短时间。

bandwidth

integer

消耗的带宽。

cacheHitCount

integer

从缓存策略提供内容的次数。

cacheMissCount

integer

从后端提取内容的次数。

callCountBlocked

integer

由于凭据无效而被阻止的调用次数。 这包括返回 HttpStatusCode.Unauthorized 和 HttpStatusCode.Forbidden 和 HttpStatusCode.TooManyRequests 的调用

callCountFailed

integer

由于网关或后端错误而失败的调用数。 这包括调用返回 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

与此记录数据相关的邮政编码。