Reports - List By User
Visar en lista över rapportposter efter användare.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser?$filter={$filter}&api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
$filter
|
query | True |
string |
| Fält | Användning | Operatorer som stöds | Funktioner som stöds | |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
$orderby
|
query |
string |
OData-ordning efter frågealternativ. |
|
$skip
|
query |
integer int32 |
Antal poster att hoppa över. |
|
$top
|
query |
integer int32 |
Antal poster som ska returneras. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Visar en samling rapportposter. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementGetReportsByUser
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byUser?$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
{
"value": [
{
"name": "Administrator",
"userId": "/users/1",
"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": "Samir Solanki",
"userId": "/users/56eaec62baf08b06e46d27fd",
"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": "Anonymous",
"userId": "/users/54c800b332965a0035030000",
"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": ""
}
Definitioner
Name | Description |
---|---|
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Report |
Sidsidig rapport registrerar listrepresentation. |
Report |
Rapportdata. |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
ReportCollection
Sidsidig rapport registrerar listrepresentation.
Name | Typ | Description |
---|---|---|
count |
integer |
Totalt antal poster på alla sidor. |
nextLink |
string |
Länk till nästa sida om det finns någon. |
value |
Sidvärden. |
ReportRecordContract
Rapportdata.
Name | Typ | Description |
---|---|---|
apiId |
string |
Sökväg för API-identifierare. /apis/{apiId} |
apiRegion |
string |
API-regionidentifierare. |
apiTimeAvg |
number |
Genomsnittlig tid det tog att bearbeta begäran. |
apiTimeMax |
number |
Maximal tid det tog att bearbeta begäran. |
apiTimeMin |
number |
Minsta tid det tog att bearbeta begäran. |
bandwidth |
integer |
Förbrukad bandbredd. |
cacheHitCount |
integer |
Antal gånger som innehåll har hanterats från en cacheprincip. |
cacheMissCount |
integer |
Antal gånger som innehåll hämtades från serverdelen. |
callCountBlocked |
integer |
Antal blockerade anrop på grund av ogiltiga autentiseringsuppgifter. Detta inkluderar anrop som returnerar HttpStatusCode.Unauthorized och HttpStatusCode.Forbidden och HttpStatusCode.TooManyRequests |
callCountFailed |
integer |
Antalet misslyckade anrop på grund av gateway- eller serverdelsfel. Detta inkluderar anrop som returnerar HttpStatusCode.BadRequest(400) och eventuell kod mellan HttpStatusCode.InternalServerError (500) och 600 |
callCountOther |
integer |
Antal andra samtal. |
callCountSuccess |
integer |
Antal lyckade anrop. Detta inkluderar anrop som returnerar HttpStatusCode <= 301 och HttpStatusCode.NotModified och HttpStatusCode.TemporaryRedirect |
callCountTotal |
integer |
Totalt antal anrop. |
country |
string |
Land som dessa postdata är relaterade till. |
interval |
string |
Aggregeringsperiodens längd. Intervallet måste vara flera av 15 minuter och får inte vara noll. Värdet ska vara i ISO 8601-format (http://en.wikipedia.org/wiki/ISO_8601#Durations). |
name |
string |
Namn beroende på rapportslutpunkt anger produkt, API, åtgärd eller utvecklarnamn. |
operationId |
string |
Sökväg till åtgärdsidentifierare. /apis/{apiId}/operations/{operationId} |
productId |
string |
Sökväg för produktidentifierare. /products/{productId} |
region |
string |
Landregion som dessa postdata är relaterade till. |
serviceTimeAvg |
number |
Genomsnittlig tid det tog att bearbeta begäran på serverdelen. |
serviceTimeMax |
number |
Maximal tid det tog att bearbeta begäran på serverdelen. |
serviceTimeMin |
number |
Minsta tid det tog att bearbeta begäran på serverdelen. |
subscriptionId |
string |
Sökväg till prenumerationsidentifierare. /subscriptions/{subscriptionId} |
timestamp |
string |
Aggregeringsperiodens början. Datumet överensstämmer med följande format: |
userId |
string |
Sökväg för användaridentifierare. /users/{userId} |
zip |
string |
Postnummer som dessa postdata är relaterade till. |