Share via

RequestReportRecordContract interface

  • Reference
Package:
@azure/arm-apimanagement

Request Report data.

Properties

apiId

API identifier path. /apis/{apiId}
apiRegion

Azure region where the gateway that processed this request is located.
apiTime

The total time it took to process this request.
backendResponseCode

The HTTP status code received by the gateway as a result of forwarding this request to the backend.
cache

Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.
ipAddress

The client IP address associated with this request.
method

The HTTP method associated with this request..
operationId

Operation identifier path. /apis/{apiId}/operations/{operationId}
productId

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.
requestId

Request Identifier.
requestSize

The size of this request..
responseCode

The HTTP status code returned by the gateway.
responseSize

The size of the response returned by the gateway.
serviceTime

he time it took to forward this request to the backend and get the response back.
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}
timestamp

The date and time when this request was received by the gateway in ISO 8601 format.
url

The full URL associated with this request.
userId

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiId

API identifier path. /apis/{apiId}

apiId?: string

Property Value

string

apiRegion

Azure region where the gateway that processed this request is located.

apiRegion?: string

Property Value

string

apiTime

The total time it took to process this request.

apiTime?: number

Property Value

number

backendResponseCode

The HTTP status code received by the gateway as a result of forwarding this request to the backend.

backendResponseCode?: string

Property Value

string

cache

Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.

cache?: string

Property Value

string

ipAddress

The client IP address associated with this request.

ipAddress?: string

Property Value

string

method

The HTTP method associated with this request..

method?: string

Property Value

string

operationId

Operation identifier path. /apis/{apiId}/operations/{operationId}

operationId?: string

Property Value

string

productId

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.

productId?: string

Property Value

string

requestId

Request Identifier.

requestId?: string

Property Value

string

requestSize

The size of this request..

requestSize?: number

Property Value

number

responseCode

The HTTP status code returned by the gateway.

responseCode?: number

Property Value

number

responseSize

The size of the response returned by the gateway.

responseSize?: number

Property Value

number

serviceTime

he time it took to forward this request to the backend and get the response back.

serviceTime?: number

Property Value

number

subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

subscriptionId?: string

Property Value

string

timestamp

The date and time when this request was received by the gateway in ISO 8601 format.

timestamp?: Date

Property Value

Date

url

The full URL associated with this request.

url?: string

Property Value

string

userId

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.

userId?: string

Property Value

string