Reports - List By Operation
API 操作別のレポート レコードを一覧表示します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation?$filter={$filter}&api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 正規表現パターン: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
$filter
|
query | True |
string |
|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
$orderby
|
query |
string |
OData の並べ替えクエリ オプション。 |
|
$skip
|
query |
integer int32 |
スキップするレコードの数。 |
|
$top
|
query |
integer int32 |
返されるレコードの数。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
レポート レコードのコレクションを一覧表示します。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementGetReportsByOperation
要求のサンプル
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byOperation?$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": "get",
"apiId": "/apis/57a03a13e4bbd5119c8b19e9",
"operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14",
"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": "GetWeatherInformation",
"apiId": "/apis/57c999d1e4bbd50c988cb2c3",
"operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e",
"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": "GetCityForecastByZIP",
"apiId": "/apis/57c999d1e4bbd50c988cb2c3",
"operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f",
"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": ""
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Report |
ページ レポート レコードのリスト表現。 |
Report |
レポート データ。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
ReportCollection
ページ レポート レコードのリスト表現。
名前 | 型 | 説明 |
---|---|---|
count |
integer |
すべてのページの合計レコード数。 |
nextLink |
string |
次のページ リンク (存在する場合)。 |
value |
ページ値。 |
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 分の倍数である必要があり、0 にすることはできません。 値は 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 |
集計期間の開始。 日付は、ISO 8601 標準で指定されている形式 |
userId |
string |
ユーザー識別子のパス。 /users/{userId} |
zip |
string |
このレコード データが関連付けられている郵便番号。 |