Reports - List By Subscription
Wyświetla listę rekordów raportów według subskrypcji.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription?$filter={$filter}&api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription?$filter={$filter}&$top={$top}&$skip={$skip}&$orderby={$orderby}&api-version=2022-08-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
service
|
path | True |
string |
Nazwa usługi API Management. Wzorzec wyrażenia regularnego: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
$filter
|
query | True |
string |
| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje | |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
$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 |
Wyświetla listę kolekcji rekordów raportu. |
|
Other Status Codes |
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
ApiManagementGetReportsBySubscription
Przykładowe żądanie
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/reports/bySubscription?$filter=timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'&api-version=2022-08-01
Przykładowa odpowiedź
{
"value": [
{
"name": "",
"userId": "/users/1",
"productId": "/products/5600b59475ff190048060001",
"subscriptionId": "/subscriptions/5600b59475ff190048070001",
"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": "",
"userId": "/users/1",
"productId": "/products/5600b59475ff190048060002",
"subscriptionId": "/subscriptions/5600b59475ff190048070002",
"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": "",
"userId": "/users/1",
"productId": "/products/5702e97e5157a50f48dce801",
"subscriptionId": "/subscriptions/5702e97e5157a50a9c733303",
"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": ""
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Report |
Reprezentacja listy stronicowanych rekordów raportu. |
Report |
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 |
Lista nieprawidłowych pól wysyłanych 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, łącze następnej strony. |
value |
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 potrzebny na przetworzenie żądania. |
apiTimeMax |
number |
Maksymalny czas potrzebny na przetworzenie żądania. |
apiTimeMin |
number |
Minimalny czas potrzebny na przetworzenie żą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 razy zawartość została pobrana z zaplecza. |
callCountBlocked |
integer |
Liczba wywołań zablokowanych z powodu nieprawidłowych poświadczeń. Obejmuje to wywołania zwracające kod HttpStatusCode.Unauthorized i HttpStatusCode.Forbidden i HttpStatusCode.TooManyRequests |
callCountFailed |
integer |
Liczba wywołań nie powiodła się z powodu błędów bramy lub zaplecza. Obejmuje to wywołania zwracające httpStatusCode.BadRequest(400) i dowolny kod między httpStatusCode.InternalServerError (500) i 600 |
callCountOther |
integer |
Liczba innych wywołań. |
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 rekordów. |
interval |
string |
Długość okresu agregacji. Interwał musi być wielokrotny 15 minut i może nie być zerowy. 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 rekordów. |
serviceTimeAvg |
number |
Średni czas potrzebny na przetworzenie żądania w zapleczu. |
serviceTimeMax |
number |
Maksymalny czas potrzebny na przetworzenie żądania w zapleczu. |
serviceTimeMin |
number |
Minimalny czas potrzebny na przetworzenie żą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: |
userId |
string |
Ścieżka identyfikatora użytkownika. /users/{userId} |
zip |
string |
Kod pocztowy, z którym są powiązane te dane rekordu. |