Reports - List By User

ユーザー別にレポート レコードを一覧表示します。

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

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 サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

$filter
query True
  • string

| フィールド | 使用法 | サポートされている演算子 | サポートされている機能 |
|-------------|-------------|-------------|-------------|
|タイムスタンプ |フィルタ |ゲ、 ル | |
|表示名 |選択,注文By | | |
|ユーザー ID |選択, フィルタ |eq | |
|アピリピリージョン |フィルタ |eq | |
|製品 Id |フィルタ |eq | |
|サブスクリプション Id |フィルタ |eq | |
|apiId |フィルタ |eq | |
|オペレーション Id |フィルタ |eq | |
|成功を呼び出す |選択,注文By | | |
|ブロックされた呼び出し |選択,注文By | | |
|呼び出しの失敗選択,注文By | | |
|コールカウントその他 |選択,注文By | | |
|カウント集計を呼び出す |選択,注文By | | |
|帯域幅 |選択,注文By | | |
|キャッシュヒッツカウント |を選択して | | |
|キャッシュミスカウント |を選択して | | |
|アピタイムアvg |選択,注文By | | |
|アピタイムミン |を選択して | | |
|アピタイムマックス |を選択して | | |
|サービスタイムアvg |を選択して | | |
|サービスタイムミン |を選択して | | |
|サービスタイムマックス |を選択して | | |

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

$orderby
query
  • string

OData の並べ替えクエリ オプション。

$skip
query
  • integer
int32

スキップするレコードの数。

$top
query
  • integer
int32

返されるレコードの数。

応答

Name Type Description
200 OK

レポート レコードのコレクションを一覧表示します。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementGetReportsByUser

Sample Request

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

Sample Response

{
  "value": [
    {
      "name": "Administrator",
      "userId": "/users/1",
      "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": "Samir Solanki",
      "userId": "/users/56eaec62baf08b06e46d27fd",
      "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": "Anonymous",
      "userId": "/users/54c800b332965a0035030000",
      "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": ""
}

定義

ReportCollection

ページ レポート レコードのリスト表現。

ReportRecordContract

レポート データ。

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

プロキシまたはバックエンド エラーが原因で失敗した呼び出しの数。 これには、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}/操作/{操作Id}

productId
  • string

製品識別子のパス。 /製品/{製品Id}

region
  • string

このレコード データが関連付けられている国の地域です。

serviceTimeAvg
  • number

バックエンドで要求を処理するのにかかった平均時間。

serviceTimeMax
  • number

バックエンドで要求を処理するのに要した最大時間。

serviceTimeMin
  • number

バックエンドで要求を処理するのにかかった最小時間。

subscriptionId
  • string

サブスクリプション識別子のパス。 /サブスクリプション/{サブスクリプションId}

timestamp
  • string

集計期間の開始。 日付は、ISO 8601yyyy-MM-ddTHH:mm:ssZ規格で指定されている形式に準拠しています。

userId
  • string

ユーザー ID パス。 /ユーザー/{ユーザーId}

zip
  • string

このレコード データが関連付けられている郵便番号。