Reports - List By Time

Referentie

Service:: API Management

API Version:: 2022-08-01

Een lijst met rapportrecords per tijd.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime?$filter={$filter}&interval={interval}&api-version=2022-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&interval={interval}&api-version=2022-08-01

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string	De naam van de API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	De id van het doelabonnement.
$filter	query	True	string	\| Veld \| Gebruik \| Ondersteunde operators \| Ondersteunde functies \| \|-------------\|-------------\|-------------\|-------------\| \| tijdstempel \| filter, selecteer \| ge, le \| \| \| interval \| selecteren \| \| \| apiRegion \| filteren \| eq \| \| \| userId \| filter \| eq \| \| \| productId \| filteren \| eq \| \| \| subscriptionId \| filter \| eq \| \| \| apiId \| filteren \| eq \| \| \| operationId \| filter \| eq \| \| \| callCountSuccess \| \| \| \| selecteren \| callCountBlocked \| selecteer \| \| \| \| callCountFailed \| \| \| \| selecteren \| callCountOther \| selecteer \| \| \| bandbreedte \| select, orderBy \| \| \| \| cacheHitsCount \| selecteer \| \| \| cacheMissCount \| \| \| \| selecteren \| apiTimeAvg \| selecteer \| \| \| \| apiTimeMin \| \| \| \| selecteren \| apiTimeMax \| selecteren \| \| \| serviceTimeAvg \| \| \| \| selecteren \| serviceTimeMin \| selecteer \| \| \| serviceTimeMax \| \| \| \| selecteren
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
interval	query	True	string duration	Op tijdsinterval. Interval moet meerdere van 15 minuten zijn en mag niet nul zijn. De waarde moet de ISO 8601-indeling () hebben.http://en.wikipedia.org/wiki/ISO_8601#Durations Deze code kan worden gebruikt om TimeSpan te converteren naar een geldige intervaltekenreeks: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
$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	ReportCollection	Hiermee wordt een verzameling rapportrecords weergegeven.
Other Status Codes	ErrorResponse	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

ApiManagementGetReportsByTime

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byTime?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&interval=PT15M&api-version=2022-08-01

import java.time.Duration;

/** Samples for Reports ListByTime. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByTime.json
     */
    /**
     * Sample code: ApiManagementGetReportsByTime.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetReportsByTime(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .reports()
            .listByTime(
                "rg1",
                "apimService1",
                "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
                Duration.parse("PT15M"),
                null,
                null,
                null,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

import isodate

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_reports_by_time.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.reports.list_by_time(
        resource_group_name="rg1",
        service_name="apimService1",
        filter="timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
        interval=isodate.parse_duration("PT15M"),
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByTime.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByTime.json
func ExampleReportsClient_NewListByTimePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReportsClient().NewListByTimePager("rg1", "apimService1", "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "PT15M", &armapimanagement.ReportsClientListByTimeOptions{Top: nil,
		Skip:    nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReportCollection = armapimanagement.ReportCollection{
		// 	Count: to.Ptr[int64](2),
		// 	Value: []*armapimanagement.ReportRecordContract{
		// 		{
		// 			APITimeAvg: to.Ptr[float64](1337.46335),
		// 			APITimeMax: to.Ptr[float64](1819.2173),
		// 			APITimeMin: to.Ptr[float64](885.0839000000001),
		// 			Bandwidth: to.Ptr[int64](3243),
		// 			CacheHitCount: to.Ptr[int32](0),
		// 			CacheMissCount: to.Ptr[int32](0),
		// 			CallCountBlocked: to.Ptr[int32](0),
		// 			CallCountFailed: to.Ptr[int32](0),
		// 			CallCountOther: to.Ptr[int32](0),
		// 			CallCountSuccess: to.Ptr[int32](4),
		// 			CallCountTotal: to.Ptr[int32](4),
		// 			Interval: to.Ptr("PT15M"),
		// 			ServiceTimeAvg: to.Ptr[float64](1255.917425),
		// 			ServiceTimeMax: to.Ptr[float64](1697.3612),
		// 			ServiceTimeMin: to.Ptr[float64](882.8264),
		// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-03T00:15:00.000Z"); return t}()),
		// 		},
		// 		{
		// 			APITimeAvg: to.Ptr[float64](872.7818777777778),
		// 			APITimeMax: to.Ptr[float64](1093.8407),
		// 			APITimeMin: to.Ptr[float64](330.3206),
		// 			Bandwidth: to.Ptr[int64](7776),
		// 			CacheHitCount: to.Ptr[int32](0),
		// 			CacheMissCount: to.Ptr[int32](0),
		// 			CallCountBlocked: to.Ptr[int32](1),
		// 			CallCountFailed: to.Ptr[int32](0),
		// 			CallCountOther: to.Ptr[int32](0),
		// 			CallCountSuccess: to.Ptr[int32](9),
		// 			CallCountTotal: to.Ptr[int32](10),
		// 			Interval: to.Ptr("PT15M"),
		// 			ServiceTimeAvg: to.Ptr[float64](824.2847111111112),
		// 			ServiceTimeMax: to.Ptr[float64](973.2262000000001),
		// 			ServiceTimeMin: to.Ptr[float64](215.24),
		// 			Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-03T00:30:00.000Z"); return t}()),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists report records by Time.
 *
 * @summary Lists report records by Time.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByTime.json
 */
async function apiManagementGetReportsByTime() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const filter =
    "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'";
  const interval = "PT15M";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reports.listByTime(
    resourceGroupName,
    serviceName,
    filter,
    interval
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "timestamp": "2017-06-03T00:15:00Z",
      "interval": "PT15M",
      "callCountSuccess": 4,
      "callCountBlocked": 0,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 4,
      "bandwidth": 3243,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 1337.46335,
      "apiTimeMin": 885.0839000000001,
      "apiTimeMax": 1819.2173,
      "serviceTimeAvg": 1255.917425,
      "serviceTimeMin": 882.8264,
      "serviceTimeMax": 1697.3612
    },
    {
      "timestamp": "2017-06-03T00:30:00Z",
      "interval": "PT15M",
      "callCountSuccess": 9,
      "callCountBlocked": 1,
      "callCountFailed": 0,
      "callCountOther": 0,
      "callCountTotal": 10,
      "bandwidth": 7776,
      "cacheHitCount": 0,
      "cacheMissCount": 0,
      "apiTimeAvg": 872.7818777777778,
      "apiTimeMin": 330.3206,
      "apiTimeMax": 1093.8407,
      "serviceTimeAvg": 824.2847111111112,
      "serviceTimeMin": 215.24,
      "serviceTimeMax": 973.2262000000001
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definities

Name	Description
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.
ReportCollection	Weergave van lijst met gepagineerde rapportrecords.
ReportRecordContract	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	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het 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 aanwezig.
value	ReportRecordContract[]	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	Het 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) en code tussen HttpStatusCode.InternalServerError (500) en 600 retourneren
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. Interval moet meerdere van 15 minuten zijn en mag niet nul zijn. De waarde moet de ISO 8601-indeling () hebben.http://en.wikipedia.org/wiki/ISO_8601#Durations
name	string	Naam, afhankelijk 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	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: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
userId	string	Pad naar gebruikers-id. /users/{userId}
zip	string	Postcode waaraan deze recordgegevens zijn gerelateerd.

Delen via

Reports - List By Time

URI-parameters

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

ApiManagementGetReportsByTime

Sample Request

Sample Response

Definities

ErrorFieldContract

ErrorResponse

ReportCollection

ReportRecordContract

Aanvullende resources