ReportRecordContract interface

パッケージ:

@azure/arm-apimanagement

レポート データ。

プロパティ

apiId	API 識別子のパス。 /apis/{apiId}
apiRegion	API リージョン識別子。
apiTimeAvg	要求の処理にかかった平均時間。
apiTimeMax	要求の処理にかかった最大時間。
apiTimeMin	要求の処理にかかった最小時間。
bandwidth	使用される帯域幅。
cacheHitCount	キャッシュ ポリシーからコンテンツが提供された回数。
cacheMissCount	バックエンドからコンテンツがフェッチされた回数。
callCountBlocked	無効な資格情報が原因でブロックされた呼び出しの数。 これには、HttpStatusCode.Unauthorized と HttpStatusCode.Forbidden と HttpStatusCode.TooManyRequests を返す呼び出しが含まれます。
callCountFailed	ゲートウェイまたはバックエンド エラーが原因で失敗した呼び出しの数。 これには、HttpStatusCode.BadRequest(400) と HttpStatusCode.InternalServerError (500) と 600 の間のすべてのコードを返す呼び出しが含まれます。
callCountOther	その他の呼び出しの数。
callCountSuccess	成功した呼び出しの数。 これには、HttpStatusCode <= 301 と HttpStatusCode.NotModified と HttpStatusCode.TemporaryRedirect を返す呼び出しが含まれます。
callCountTotal	呼び出しの合計数。
country	このレコード データが関連付けられている国。
interval	集計期間の長さ。 間隔は 15 分の倍数である必要があり、ゼロにすることはできません。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。
name	レポート エンドポイントに応じた名前は、製品、API、操作、または開発者名を指定します。
operationId	操作識別子のパス。 /apis/{apiId}/operations/{operationId}
productId	製品識別子のパス。 /products/{productId} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
region	このレコード データが関連付けられている国リージョン。
serviceTimeAvg	バックエンドでの要求の処理にかかった平均時間。
serviceTimeMax	バックエンドでの要求の処理にかかった最大時間。
serviceTimeMin	バックエンドでの要求の処理にかかった最小時間。
subscriptionId	サブスクリプション識別子のパス。 /subscriptions/{subscriptionId}
timestamp	集計期間の開始。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
userId	ユーザー識別子のパス。 /users/{userId} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
zip	このレコード データが関連付けられている郵便番号。

プロパティの詳細

apiId

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

apiId?: string

プロパティ値

string

apiRegion

API リージョン識別子。

apiRegion?: string

プロパティ値

string

apiTimeAvg

要求の処理にかかった平均時間。

apiTimeAvg?: number

プロパティ値

number

apiTimeMax

要求の処理にかかった最大時間。

apiTimeMax?: number

プロパティ値

number

apiTimeMin

要求の処理にかかった最小時間。

apiTimeMin?: number

プロパティ値

number

bandwidth

使用される帯域幅。

bandwidth?: number

プロパティ値

number

cacheHitCount

キャッシュ ポリシーからコンテンツが提供された回数。

cacheHitCount?: number

プロパティ値

number

cacheMissCount

バックエンドからコンテンツがフェッチされた回数。

cacheMissCount?: number

プロパティ値

number

callCountBlocked

無効な資格情報が原因でブロックされた呼び出しの数。 これには、HttpStatusCode.Unauthorized と HttpStatusCode.Forbidden と HttpStatusCode.TooManyRequests を返す呼び出しが含まれます。

callCountBlocked?: number

プロパティ値

number

callCountFailed

ゲートウェイまたはバックエンド エラーが原因で失敗した呼び出しの数。 これには、HttpStatusCode.BadRequest(400) と HttpStatusCode.InternalServerError (500) と 600 の間のすべてのコードを返す呼び出しが含まれます。

callCountFailed?: number

プロパティ値

number

callCountOther

その他の呼び出しの数。

callCountOther?: number

プロパティ値

number

callCountSuccess

成功した呼び出しの数。 これには、HttpStatusCode <= 301 と HttpStatusCode.NotModified と HttpStatusCode.TemporaryRedirect を返す呼び出しが含まれます。

callCountSuccess?: number

プロパティ値

number

callCountTotal

呼び出しの合計数。

callCountTotal?: number

プロパティ値

number

country

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

country?: string

プロパティ値

string

interval

集計期間の長さ。 間隔は 15 分の倍数である必要があり、ゼロにすることはできません。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。

interval?: string

プロパティ値

string

name

レポート エンドポイントに応じた名前は、製品、API、操作、または開発者名を指定します。

name?: string

プロパティ値

string

operationId

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

operationId?: string

プロパティ値

string

productId

製品識別子のパス。 /products/{productId} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

productId?: string

プロパティ値

string

region

このレコード データが関連付けられている国リージョン。

region?: string

プロパティ値

string

serviceTimeAvg

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

serviceTimeAvg?: number

プロパティ値

number

serviceTimeMax

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

serviceTimeMax?: number

プロパティ値

number

serviceTimeMin

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

serviceTimeMin?: number

プロパティ値

number

subscriptionId

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

subscriptionId?: string

プロパティ値

string

timestamp

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

timestamp?: Date

プロパティ値

Date

userId

ユーザー識別子のパス。 /users/{userId} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

userId?: string

プロパティ値

string

zip

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

zip?: string

プロパティ値

string