Reports - List By Operation

Referens

Service:: API Management

API Version:: 2022-08-01

Visar en lista över rapportposter efter API Operations.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID för målprenumerationen.
$filter	query	True	string	\| Fält \| Användning \| Operatorer som stöds \| Funktioner som stöds \| \|-------------\|-------------\|-------------\|-------------\| \| tidsstämpel \| filter \| ge, le \| \| \| displayName \| select, orderBy \| \| \| \| \| apiRegion \| filter \| eq \| \| \| userId \| filter \| eq \| \| \| \| productId \| filter \| eq \| \| \| subscriptionId \| filter \| eq \| \| \| \| \| apiId \| filter \| eq \| \| \| operationId \| select, filter \| eq \| \| \| \| callCountSuccess \| select, orderBy \| \| \| \| \| callCountBlocked \| select, orderBy \| \| \| \| \| callCountFailed \| select, orderBy \| \| \| \| \| callCountOther \| select, orderBy \| \| \| \| \| callCountTotal \| select, orderBy \| \| \| \| \| bandbredd \| välj, orderBy \| \| \| \| \| \| cacheHitsCount \| välj \| \| \| \| \| cacheMissCount \| välj \| \| \| \| \| \| apiTimeAvg \| select, orderBy \| \| \| \| \| apiTimeMin \| välj \| \| \| \| \| \| apiTimeMax \| välj \| \| \| \| \| serviceTimeAvg \| välj \| \| \| \| \| \| serviceTimeMin \| välj \| \| \| \| \| serviceTimeMax \| välj \| \| \| \|
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	ReportCollection	Visar en samling rapportposter.
Other Status Codes	ErrorResponse	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

ApiManagementGetReportsByOperation

Sample Request

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

/** Samples for Reports ListByOperation. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByOperation.json
     */
    /**
     * Sample code: ApiManagementGetReportsByOperation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetReportsByOperation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .reports()
            .listByOperation(
                "rg1",
                "apimService1",
                "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
                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

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_operation.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_operation(
        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'",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByOperation.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/ApiManagementGetReportsByOperation.json
func ExampleReportsClient_NewListByOperationPager() {
	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().NewListByOperationPager("rg1", "apimService1", "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", &armapimanagement.ReportsClientListByOperationOptions{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](3),
		// 	Value: []*armapimanagement.ReportRecordContract{
		// 		{
		// 			Name: to.Ptr("get"),
		// 			OperationID: to.Ptr("/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14"),
		// 			APIID: to.Ptr("/apis/57a03a13e4bbd5119c8b19e9"),
		// 			APITimeAvg: to.Ptr[float64](1015.7607923076923),
		// 			APITimeMax: to.Ptr[float64](1819.2173),
		// 			APITimeMin: to.Ptr[float64](330.3206),
		// 			Bandwidth: to.Ptr[int64](11019),
		// 			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](13),
		// 			CallCountTotal: to.Ptr[int32](14),
		// 			ServiceTimeAvg: to.Ptr[float64](957.094776923077),
		// 			ServiceTimeMax: to.Ptr[float64](1697.3612),
		// 			ServiceTimeMin: to.Ptr[float64](215.24),
		// 		},
		// 		{
		// 			Name: to.Ptr("GetWeatherInformation"),
		// 			OperationID: to.Ptr("/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e"),
		// 			APIID: to.Ptr("/apis/57c999d1e4bbd50c988cb2c3"),
		// 			APITimeAvg: to.Ptr[float64](0),
		// 			APITimeMax: to.Ptr[float64](0),
		// 			APITimeMin: to.Ptr[float64](0),
		// 			Bandwidth: to.Ptr[int64](0),
		// 			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](0),
		// 			CallCountTotal: to.Ptr[int32](0),
		// 			ServiceTimeAvg: to.Ptr[float64](0),
		// 			ServiceTimeMax: to.Ptr[float64](0),
		// 			ServiceTimeMin: to.Ptr[float64](0),
		// 		},
		// 		{
		// 			Name: to.Ptr("GetCityForecastByZIP"),
		// 			OperationID: to.Ptr("/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f"),
		// 			APIID: to.Ptr("/apis/57c999d1e4bbd50c988cb2c3"),
		// 			APITimeAvg: to.Ptr[float64](0),
		// 			APITimeMax: to.Ptr[float64](0),
		// 			APITimeMin: to.Ptr[float64](0),
		// 			Bandwidth: to.Ptr[int64](0),
		// 			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](0),
		// 			CallCountTotal: to.Ptr[int32](0),
		// 			ServiceTimeAvg: to.Ptr[float64](0),
		// 			ServiceTimeMax: to.Ptr[float64](0),
		// 			ServiceTimeMin: to.Ptr[float64](0),
		// 	}},
		// }
	}
}

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 API Operations.
 *
 * @summary Lists report records by API Operations.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByOperation.json
 */
async function apiManagementGetReportsByOperation() {
  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 credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reports.listByOperation(resourceGroupName, serviceName, filter)) {
    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": [
    {
      "name": "get",
      "apiId": "/apis/57a03a13e4bbd5119c8b19e9",
      "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14",
      "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": "GetWeatherInformation",
      "apiId": "/apis/57c999d1e4bbd50c988cb2c3",
      "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e",
      "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": "GetCityForecastByZIP",
      "apiId": "/apis/57c999d1e4bbd50c988cb2c3",
      "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f",
      "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
ErrorFieldContract	Fel Fältkontrakt.
ErrorResponse	Felsvar.
ReportCollection	Listrepresentation av sidade rapportposter.
ReportRecordContract	Rapportera data.

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	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message	string	Mänsklig läsbar representation av felet.

ReportCollection

Listrepresentation av sidade rapportposter.

Name	Typ	Description
count	integer	Totalt antal poster på alla sidor.
nextLink	string	Om det finns någon länk till nästa sida.
value	ReportRecordContract[]	Sidvärden.

ReportRecordContract

Rapportera data.

Name	Typ	Description
apiId	string	API-identifierarsökväg. /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 då innehåll hanterades från cacheprincipen.
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 anrop.
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 till 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: `yyyy-MM-ddTHH:mm:ssZ` enligt iso 8601-standarden.
userId	string	Sökväg för användaridentifierare. /users/{userId}
zip	string	Postnummer som dessa postdata är relaterade till.

Dela via

Reports - List By Operation

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

ApiManagementGetReportsByOperation

Sample Request

Sample Response

Definitioner

ErrorFieldContract

ErrorResponse

ReportCollection

ReportRecordContract

Ytterligare resurser