Reports - List By Geo

Odwołanie

Service:: API Management

API Version:: 2022-08-01

Wyświetla listę rekordów raportów według lokalizacji geograficznej.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo?$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/byGeo?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName	path	True	string	Nazwa usługi API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
$filter	query	True	string	\| Pole \| Użycie \| Obsługiwane operatory \| Obsługiwane funkcje \| \|-------------\|-------------\|-------------\|-------------\| \| sygnatura czasowa \| filter \| ge, le \| \| \| kraj \| select \| \| \| \| region \| wybierz \| \| \| \| zip \| select \| \| \| \| apiRegion \| filter \| eq \| \| \| userId \| filter \| eq \| \| \| productId \| filter \| eq \| \| \| subscriptionId \| filter \| eq \| \| \| apiId \| filter \| eq \| \| \| operationId \| filter \| eq \| \| \| callCountSuccess \| wybierz \| \| \| \| callCountBlocked \| select \| \| \| \| callCountFailed \| wybierz \| \| \| \| callCountOther \| select \| \| \| \| przepustowość \| select, orderBy \| \| \| \| cacheHitsCount \| select \| \| \| \| cacheMissCount \| wybierz \| \| \| \| apiTimeAvg \| select \| \| \| \| apiTimeMin \| wybierz \| \| \| \| apiTimeMax \| select \| \| \| \| \| serviceTimeAvg \| wybierz \| \| \| \| serviceTimeMin \| select \| \| \| \| \| serviceTimeMax \| wybierz \| \| \|
api-version	query	True	string	Wersja interfejsu API do użycia na potrzeby tej operacji.
$skip	query		integer int32	Liczba rekordów do pominięcia.
$top	query		integer int32	Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReportCollection	Wyświetla listę kolekcji rekordów raportu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementGetReportsByGeo

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/byGeo?$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 ListByGeo. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByGeo.json
     */
    /**
     * Sample code: ApiManagementGetReportsByGeo.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetReportsByGeo(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .reports()
            .listByGeo(
                "rg1",
                "apimService1",
                "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'",
                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_geo.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_geo(
        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/ApiManagementGetReportsByGeo.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/ApiManagementGetReportsByGeo.json
func ExampleReportsClient_NewListByGeoPager() {
	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().NewListByGeoPager("rg1", "apimService1", "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", &armapimanagement.ReportsClientListByGeoOptions{Top: nil,
		Skip: 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{
		// 	Value: []*armapimanagement.ReportRecordContract{
		// 		{
		// 			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),
		// 			Country: to.Ptr("US"),
		// 			Region: to.Ptr("WA"),
		// 			ServiceTimeAvg: to.Ptr[float64](957.094776923077),
		// 			ServiceTimeMax: to.Ptr[float64](1697.3612),
		// 			ServiceTimeMin: to.Ptr[float64](215.24),
		// 			Zip: to.Ptr("98052"),
		// 	}},
		// }
	}
}

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 geography.
 *
 * @summary Lists report records by geography.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetReportsByGeo.json
 */
async function apiManagementGetReportsByGeo() {
  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.listByGeo(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": [
    {
      "country": "US",
      "region": "WA",
      "zip": "98052",
      "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
    }
  ],
  "nextLink": ""
}

Definicje

Nazwa	Opis
ErrorFieldContract	Błąd Kontrakt pola.
ErrorResponse	Odpowiedź na błąd.
ReportCollection	Reprezentacja listy stronicowanych rekordów raportu.
ReportRecordContract	Dane raportu.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error.code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details	ErrorFieldContract[]	Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.
error.message	string	Czytelna dla człowieka reprezentacja błędu.

ReportCollection

Reprezentacja listy stronicowanych rekordów raportu.

Nazwa	Typ	Opis
count	integer	Łączna liczba rekordów na wszystkich stronach.
nextLink	string	Jeśli istnieje link do następnej strony.
value	ReportRecordContract[]	Wartości stron.

ReportRecordContract

Dane raportu.

Nazwa	Typ	Opis
apiId	string	Ścieżka identyfikatora interfejsu API. /apis/{apiId}
apiRegion	string	Identyfikator regionu interfejsu API.
apiTimeAvg	number	Średni czas przetwarzania żądania.
apiTimeMax	number	Maksymalny czas przetwarzania żądania.
apiTimeMin	number	Minimalny czas przetwarzania żądania.
bandwidth	integer	Zużytą przepustowość.
cacheHitCount	integer	Liczba razy, kiedy zawartość została obsłużona z zasad pamięci podręcznej.
cacheMissCount	integer	Liczba pobrań zawartości z zaplecza.
callCountBlocked	integer	Liczba wywołań zablokowanych z powodu nieprawidłowych poświadczeń. Obejmuje to wywołania zwracające httpStatusCode.Unauthorized i HttpStatusCode.Forbidden i HttpStatusCode.TooManyRequests
callCountFailed	integer	Liczba wywołań zakończonych niepowodzeniem z powodu błędów bramy lub zaplecza. Obejmuje to wywołania zwracające kod HttpStatusCode.BadRequest(400) i dowolny kod między httpStatusCode.InternalServerError (500) i 600
callCountOther	integer	Liczba innych połączeń.
callCountSuccess	integer	Liczba pomyślnych wywołań. Obejmuje to wywołania zwracające kod HttpStatusCode <= 301 i HttpStatusCode.NotModified i HttpStatusCode.TemporaryRedirect
callCountTotal	integer	Łączna liczba wywołań.
country	string	Kraj, z którym są powiązane te dane rekordu.
interval	string	Długość okresu agregacji. Interwał musi być wielokrotny 15 minut i może nie być równy zero. Wartość powinna być w formacie ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations).
name	string	Nazwa w zależności od punktu końcowego raportu określa produkt, interfejs API, operację lub nazwę dewelopera.
operationId	string	Ścieżka identyfikatora operacji. /apis/{apiId}/operations/{operationId}
productId	string	Ścieżka identyfikatora produktu. /products/{productId}
region	string	Region kraju, z którym są powiązane te dane rekordu.
serviceTimeAvg	number	Średni czas przetwarzania żądania w zapleczu.
serviceTimeMax	number	Maksymalny czas przetwarzania żądania w zapleczu.
serviceTimeMin	number	Minimalny czas przetwarzania żądania w zapleczu.
subscriptionId	string	Ścieżka identyfikatora subskrypcji. /subscriptions/{subscriptionId}
timestamp	string	Początek okresu agregacji. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` zgodnie z normą ISO 8601.
userId	string	Ścieżka identyfikatora użytkownika. /users/{userId}
zip	string	Kod pocztowy, z którym są powiązane te dane rekordu.

Reports - List By Geo

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

ApiManagementGetReportsByGeo

Sample Request

Sample Response

Definicje

ErrorFieldContract

ErrorResponse

ReportCollection

ReportRecordContract

Dodatkowe zasoby