次の方法で共有

Reports - List By Request

  • リファレンス
Service:
API Management
API Version:
2022-08-01

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

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

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

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

string

ターゲット サブスクリプションの ID。
$filter
 query True

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
| apiId | filter | eq | | |
operationId |filter |eq | |
| productId | filter | eq | | |
userId |filter |eq | |
| apiRegion | filter | eq | | |
subscriptionId |filter |eq | |

api-version
 query True

string

この操作に使用する API バージョン。
$skip
 query

integer

int32

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

integer

int32

返されるレコードの数。

応答

名前 型 説明
200 OK

RequestReportCollection

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

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前 説明
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=2022-08-01

Sample Response

Status code:
200 
{
  "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.675400000000001,
      "serviceTime": 0,
      "apiRegion": "East Asia",
      "subscriptionId": "/subscriptions/5600b59475ff190048070002",
      "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04",
      "requestSize": 0
    }
  ],
  "count": 2
}

定義

名前 説明
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
RequestReportCollection

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

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

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

RequestReportCollection

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

名前 型 説明
count

integer

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

RequestReportRecordContract[]

ページ値。

RequestReportRecordContract

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

名前 型 説明
apiId

string

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

string

この要求を処理したゲートウェイが配置されている Azure リージョン。
apiTime

number

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

string

この要求をバックエンドに転送した結果としてゲートウェイによって受信された HTTP 状態コード。
cache

string

応答キャッシュが応答の生成に関与したかどうかを指定します。 値が none の場合、キャッシュは使用されませんでした。 値がヒットした場合は、キャッシュされた応答が返されました。 値が miss の場合、キャッシュが使用されましたが、ルックアップによってミスが発生し、バックエンドによって要求が満たされました。
ipAddress

string

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

string

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

string

操作識別子のパス。 /apis/{apiId}/operations/{operationId}
productId

string

製品識別子のパス。 /products/{productId}
requestId

string

要求識別子。
requestSize

integer

この要求のサイズ。.
responseCode

integer

ゲートウェイによって返される HTTP 状態コード。
responseSize

integer

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

number

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

string

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

string

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

string

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

string

ユーザー識別子のパス。 /users/{userId}