Reports - List By Product
Een lijst met rapportrecords per product.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct?$filter={$filter}&api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
subscription
|
path | True |
string |
De id van het doelabonnement. |
$filter
|
query | True |
string |
| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies | |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
$orderby
|
query |
string |
OData-volgorde op queryoptie. |
|
$skip
|
query |
integer int32 |
Aantal records dat moet worden overgeslagen. |
|
$top
|
query |
integer int32 |
Het aantal te retourneren records. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Hiermee wordt een verzameling rapportrecords weergegeven. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
ApiManagementGetReportsByProduct
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byProduct?$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": "Starter",
"productId": "/products/5600b59475ff190048060001",
"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": "Unlimited",
"productId": "/products/5600b59475ff190048060002",
"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
}
],
"count": 2,
"nextLink": ""
}
Definities
Name | Description |
---|---|
Error |
Fout veldcontract. |
Error |
Foutreactie. |
Report |
Weergave van lijst met gepagineerde rapportrecords. |
Report |
Rapportgegevens. |
ErrorFieldContract
Fout veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
ReportCollection
Weergave van lijst met gepagineerde rapportrecords.
Name | Type | Description |
---|---|---|
count |
integer |
Totaal aantal records voor alle pagina's. |
nextLink |
string |
Koppeling naar volgende pagina, indien van toepassing. |
value |
Paginawaarden. |
ReportRecordContract
Rapportgegevens.
Name | Type | Description |
---|---|---|
apiId |
string |
API-id-pad. /apis/{apiId} |
apiRegion |
string |
API-regio-id. |
apiTimeAvg |
number |
De gemiddelde tijd die nodig was om de aanvraag te verwerken. |
apiTimeMax |
number |
Maximale tijd die nodig was om de aanvraag te verwerken. |
apiTimeMin |
number |
Minimale tijd die nodig was om de aanvraag te verwerken. |
bandwidth |
integer |
Verbruikte bandbreedte. |
cacheHitCount |
integer |
Aantal keren dat inhoud is geleverd vanuit cachebeleid. |
cacheMissCount |
integer |
Aantal keren dat inhoud is opgehaald uit de back-end. |
callCountBlocked |
integer |
Aantal geblokkeerde aanroepen vanwege ongeldige referenties. Dit omvat aanroepen die HttpStatusCode.Unauthorized en HttpStatusCode.Forbidden en HttpStatusCode.TooManyRequests retourneren |
callCountFailed |
integer |
Het aantal aanroepen is mislukt vanwege gateway- of back-endfouten. Dit omvat aanroepen die HttpStatusCode.BadRequest(400) retourneren en code tussen HttpStatusCode.InternalServerError (500) en 600 |
callCountOther |
integer |
Aantal andere oproepen. |
callCountSuccess |
integer |
Aantal geslaagde oproepen. Dit omvat aanroepen die HttpStatusCode <= 301 en HttpStatusCode.NotModified en HttpStatusCode.TemporaryRedirect retourneren |
callCountTotal |
integer |
Totaal aantal oproepen. |
country |
string |
Het land waaraan deze recordgegevens zijn gerelateerd. |
interval |
string |
Lengte van de aggregatieperiode. Het interval moet een veelvoud van 15 minuten zijn en mag niet nul zijn. De waarde moet de ISO 8601-indeling (http://en.wikipedia.org/wiki/ISO_8601#Durations) hebben. |
name |
string |
Naam die afhankelijk is van het rapporteindpunt, geeft de naam van het product, de API, de bewerking of de naam van de ontwikkelaar op. |
operationId |
string |
Pad naar bewerkings-id. /apis/{apiId}/operations/{operationId} |
productId |
string |
Pad naar product-id. /products/{productId} |
region |
string |
Landregio waaraan deze recordgegevens zijn gerelateerd. |
serviceTimeAvg |
number |
De gemiddelde tijd die nodig was om de aanvraag op de back-end te verwerken. |
serviceTimeMax |
number |
Maximale tijd die nodig was om de aanvraag op de back-end te verwerken. |
serviceTimeMin |
number |
Minimale tijd die nodig was om de aanvraag op de back-end te verwerken. |
subscriptionId |
string |
Pad naar abonnements-id. /subscriptions/{subscriptionId} |
timestamp |
string |
Begin van de aggregatieperiode. De datum voldoet aan de volgende notatie: |
userId |
string |
Pad naar gebruikers-id. /users/{userId} |
zip |
string |
Postcode waaraan deze recordgegevens zijn gerelateerd. |