Reports - List By Request

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest?$filter={$filter}&api-version=2019-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest?$filter={$filter}&$top={$top}&$skip={$skip}&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

| フィールド | 使用法 | サポートされている演算子 | サポートされている機能 |
|-------------|-------------|-------------|-------------|
|タイムスタンプ |フィルタ |ゲ、 ル | |
|apiId |フィルタ |eq | |
|オペレーション Id |フィルタ |eq | |
|製品 Id |フィルタ |eq | |
|ユーザー ID |フィルタ |eq | |
|アピリピリージョン |フィルタ |eq | |
|サブスクリプション Id |フィルタ |eq | |

api-version
query True
  • string

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

$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 ユーザー アカウントを偽装する

ApiManagementGetReportsByRequest

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byRequest?$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": [
    {
      "apiId": "/apis/5931a75ae4bbd512a88c680b",
      "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
      "productId": "/products/-",
      "userId": "/users/1",
      "method": "GET",
      "url": "https://apimService1.azure-api.net/echo/resource?param1=sample",
      "ipAddress": "207.xx.155.xx",
      "responseCode": 404,
      "responseSize": 405,
      "timestamp": "2017-06-03T00:17:00.1649134Z",
      "cache": "none",
      "apiTime": 221.1544,
      "serviceTime": 0,
      "apiRegion": "East Asia",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f",
      "requestSize": 0
    },
    {
      "apiId": "/apis/5931a75ae4bbd512a88c680b",
      "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-",
      "productId": "/products/-",
      "userId": "/users/1",
      "method": "POST",
      "url": "https://apimService1.azure-api.net/echo/resource",
      "ipAddress": "207.xx.155.xx",
      "responseCode": 404,
      "responseSize": 403,
      "timestamp": "2017-06-03T00:17:20.5255131Z",
      "cache": "none",
      "apiTime": 6.6754000000000007,
      "serviceTime": 0,
      "apiRegion": "East Asia",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04",
      "requestSize": 0
    }
  ],
  "count": 2
}

定義

RequestReportCollection

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

RequestReportRecordContract

レポート データを要求します。

RequestReportCollection

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

Name Type Description
count
  • integer

すべてのページのレコード数の合計。

value

ページ値。

RequestReportRecordContract

レポート データを要求します。

Name Type Description
apiId
  • string

API 識別子のパス。 /apis/{apiId}

apiRegion
  • string

この要求を処理したゲートウェイが存在する Azure リージョン。

apiTime
  • number

この要求の処理にかかった合計時間。

backendResponseCode
  • string

この要求をバックエンドに転送した結果としてゲートウェイが受信した HTTP ステータス コード。

cache
  • string

応答キャッシュが応答の生成に関与しているかどうかを指定します。 値が none の場合、キャッシュは使用されませんでした。 値がヒットした場合、キャッシュされた応答が返されました。 値が見逃した場合、キャッシュは使用されましたが、検索の結果、ミスが発生し、バックエンドによって要求が処理されました。

ipAddress
  • string

この要求に関連付けられているクライアント IP アドレス。

method
  • string

この要求に関連付けられている HTTP メソッド。

operationId
  • string

操作識別子のパス。 /apis/{apiId}/操作/{操作Id}

productId
  • string

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

requestId
  • string

要求識別子。

requestSize
  • integer

この要求のサイズ。

responseCode
  • integer

ゲートウェイによって返される HTTP ステータス コード。

responseSize
  • integer

ゲートウェイによって返される応答のサイズ。

serviceTime
  • number

この要求をバックエンドに転送し、応答を取り戻すのに時間がかかりました。

subscriptionId
  • string

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

timestamp
  • string

この要求が、ISO 8601 形式のゲートウェイによって受信された日時。

url
  • string

この要求に関連付けられている完全な URL。

userId
  • string

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