Reports - List By Time

Service:

API Management

API Version:

2022-08-01

Rapor kayıtlarını Zamana göre listeler.

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
$filter	query	True	string	| Alan | Kullanım | Desteklenen işleçler | Desteklenen işlevler | |-------------|-------------|-------------|-------------| | zaman damgası | filtreleyin, | öğesini seçin ge, le | | | interval | select | | | | apiRegion | filtre | eq | | | userId | filter | eq | | | productId | filtre | eq | | | subscriptionId | filter | eq | | | apiId | filtre | eq | | | operationId | filter | eq | | | callCountSuccess | select | | | | callCountBlocked | select | | | | callCountFailed | select | | | | callCountOther | select | | | | bant genişliği | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | |
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
interval	query	True	string duration	Zaman aralığına göre. Aralık 15 dakikanın katı olmalı ve sıfır olmayabilir. Değer ISO 8601 biçiminde olmalıdır (http://en.wikipedia.org/wiki/ISO_8601#Durations). Bu kod TimeSpan'ı geçerli bir aralık dizesine dönüştürmek için kullanılabilir: XmlConvert.ToString(yeni TimeSpan(saat, dakika, saniye)).
$orderby	query		string	Sorguya göre OData sırası seçeneği.
$skip	query		integer int32	At edilecek kayıt sayısı.
$top	query		integer int32	Döndürülecek kayıt sayısı.

Yanıtlar

Name	Tür	Description
200 OK	ReportCollection	Rapor kaydı koleksiyonunu listeler.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementGetReportsByTime

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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": ""
}

Tanımlar

Name	Description
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
ReportCollection	Sayfalanmış Rapor kayıtları listesi gösterimi.
ReportRecordContract	Rapor verileri.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilen gösterimi.

ReportCollection

Sayfalanmış Rapor kayıtları listesi gösterimi.

Name	Tür	Description
count	integer	Tüm sayfalardaki toplam kayıt sayısı.
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	ReportRecordContract[]	Sayfa değerleri.

ReportRecordContract

Rapor verileri.

Name	Tür	Description
apiId	string	API tanımlayıcı yolu. /apis/{apiId}
apiRegion	string	API bölge tanımlayıcısı.
apiTimeAvg	number	İsteğin işlenmesi için geçen ortalama süre.
apiTimeMax	number	İsteği işlemek için geçen en uzun süre.
apiTimeMin	number	İsteği işlemek için gereken en kısa süre.
bandwidth	integer	Kullanılan bant genişliği.
cacheHitCount	integer	önbellek ilkesinden içeriğin sunulma sayısı.
cacheMissCount	integer	Arka uçtan içeriğin kaç kez getirildiği.
callCountBlocked	integer	Geçersiz kimlik bilgileri nedeniyle engellenen çağrı sayısı. Bu, HttpStatusCode.Unauthorized ve HttpStatusCode.Forbidden ve HttpStatusCode.TooManyRequests döndüren çağrıları içerir
callCountFailed	integer	Ağ geçidi veya arka uç hataları nedeniyle başarısız olan çağrı sayısı. Buna HttpStatusCode.BadRequest(400) döndüren çağrılar ve HttpStatusCode.InternalServerError (500) ile 600 arasındaki herhangi bir Kod dahildir
callCountOther	integer	Diğer aramaların sayısı.
callCountSuccess	integer	Başarılı çağrı sayısı. Bu, HttpStatusCode <= 301 ve HttpStatusCode.NotModified ve HttpStatusCode.TemporaryRedirect döndüren çağrıları içerir
callCountTotal	integer	Toplam arama sayısı.
country	string	Bu kayıt verilerinin ilişkili olduğu ülke.
interval	string	Toplama döneminin uzunluğu. Aralık 15 dakikanın katı olmalı ve sıfır olmayabilir. Değer ISO 8601 biçiminde olmalıdır (http://en.wikipedia.org/wiki/ISO_8601#Durations).
name	string	Rapor uç noktasına bağlı olarak ad ürün, API, işlem veya geliştirici adını belirtir.
operationId	string	İşlem tanımlayıcı yolu. /apis/{apiId}/operations/{operationId}
productId	string	Ürün tanımlayıcı yolu. /products/{productId}
region	string	Bu kayıt verilerinin ilişkili olduğu ülke bölgesi.
serviceTimeAvg	number	Arka uçta isteğin işlenmesi için geçen ortalama süre.
serviceTimeMax	number	Arka uçta isteğin işlenmesi için geçen en uzun süre.
serviceTimeMin	number	Arka uçta isteğin işlenmesi için geçen en kısa süre.
subscriptionId	string	Abonelik tanımlayıcı yolu. /subscriptions/{subscriptionId}
timestamp	string	Toplama döneminin başlangıcı. Tarih şu biçime uygundur: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi.
userId	string	Kullanıcı tanımlayıcı yolu. /users/{userId}
zip	string	Bu kayıt verilerinin ilişkili olduğu posta kodu.