Udostępnij za pośrednictwem


Reports - List By Time

Wyświetla listę rekordów raportu według czasu.

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
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

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.

Wzorzec wyrażenia regularnego: ^[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 | filtruj, wybierz | ge, le | |
| interwał | wybór | | | |
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 dla tej operacji.

interval
query True

string

duration

Według przedziału czasu. 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). Ten kod może służyć do konwertowania elementu TimeSpan na prawidłowy ciąg interwału: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).

$orderby
query

string

Opcja OData order by query (Kolejność OData według zapytania).

$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.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementGetReportsByTime

Przykładowe żądanie

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

Przykładowa odpowiedź

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

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.