Megosztás a következőn keresztül:

Reports - List By Subscription

  • Referencia
Szolgáltatás:
API Management
API-verzió:
2024-05-01

A jelentésrekordokat előfizetések szerint listázza.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription?$filter={$filter}&api-version=2024-05-01
Opcionális paraméterekkel: 
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=2024-05-01

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Az API Management szolgáltatás neve.
subscriptionId
 path True

string (uuid)

A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
$filter
 query True

string

| Mező | Használat | Támogatott operátorok | Támogatott függvények |
|-------------|-------------|-------------|-------------|
| időbélyeg | szűrő | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | szűrő | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| sávszélesség | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |

api-version
 query True

string

minLength: 1

A művelethez használni kívánt API-verzió.
$orderby
 query

string

OData-sorrend lekérdezési beállítás szerint.
$skip
 query

integer (int32)

minimum: 0

Kihagyandó rekordok száma.
$top
 query

integer (int32)

minimum: 1

A visszaadni kívánt rekordok száma.

Válaszok

Name Típus Description
200 OK

ReportCollection

A jelentésrekordok gyűjteményét sorolja fel.
Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

ApiManagementGetReportsBySubscription

Mintakérelem

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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=2024-05-01

Mintaválasz

Állapotkód:
200 
{
  "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": ""
}

Definíciók

Name Description
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.
ErrorDetail

A hiba részletei.
ErrorResponse

Hibaválasz
ReportCollection

A lapszámozott jelentés listaábrázolást rögzít.
ReportRecordContract

Jelentésadatok.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.
type

string

A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.
code

string

A hibakód.
details

ErrorDetail[]

A hiba részletei.
message

string

A hibaüzenet.
target

string

A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

ReportCollection

Objektum

A lapszámozott jelentés listaábrázolást rögzít.

Name Típus Description
count

integer (int64)

Összes rekordszám az összes oldalon.
nextLink

string

Ha van ilyen, a következő oldal hivatkozása.
value

ReportRecordContract[]

Oldalértékek.

ReportRecordContract

Objektum

Jelentésadatok.

Name Típus Description
apiId

string

API-azonosító elérési útja. /apis/{apiId}
apiRegion

string

API-régióazonosító.
apiTimeAvg

number (double)

A kérelem feldolgozásának átlagos időtartama.
apiTimeMax

number (double)

A kérelem feldolgozásának maximális időtartama.
apiTimeMin

number (double)

A kérelem feldolgozásához szükséges minimális idő.
bandwidth

integer (int64)

Felhasznált sávszélesség.
cacheHitCount

integer (int32)

A tartalom gyorsítótárszabályzatból való kézbesítésének száma.
cacheMissCount

integer (int32)

A tartalom lekérésének száma a háttérrendszerből.
callCountBlocked

integer (int32)

Érvénytelen hitelesítő adatok miatt blokkolt hívások száma. Ide tartoznak a HttpStatusCode.Jogosulatlan és a HttpStatusCode.Forbidden és a HttpStatusCode.TooManyRequests hívásai.
callCountFailed

integer (int32)

Az átjáró vagy a háttérrendszer hibái miatt meghiúsult hívások száma. Ide tartoznak a HttpStatusCode.BadRequest(400) és a HttpStatusCode.InternalServerError (500) és a 600 közötti kódokat visszaadó hívások.
callCountOther

integer (int32)

Egyéb hívások száma.
callCountSuccess

integer (int32)

Sikeres hívások száma. Ide tartoznak a HttpStatusCode <= 301 és a HttpStatusCode.NotModified és a HttpStatusCode.TemporaryRedirect hívásai
callCountTotal

integer (int32)

Hívások teljes száma.
country

string

Az az ország, amelyhez a rekordadatok kapcsolódnak.
interval

string

Az összesítési időszak hossza. Az intervallumnak 15 perc többszörösének kell lennie, és nem lehet nulla. Az értéknek ISO 8601 formátumban (http://en.wikipedia.org/wiki/ISO_8601#Durations) kell lennie.
name

string

A jelentésvégponttól függően a név megadja a termék, az API, a művelet vagy a fejlesztő nevét.
operationId

string

Műveletazonosító elérési útja. /apis/{apiId}/operations/{operationId}
productId

string

Termékazonosító elérési útja. /products/{productId}
region

string

Országrégió, amelyhez ezek a rekordadatok kapcsolódnak.
serviceTimeAvg

number (double)

A kérések háttérrendszeren történő feldolgozásának átlagos időtartama.
serviceTimeMax

number (double)

A kérések háttérrendszeren történő feldolgozásának maximális időtartama.
serviceTimeMin

number (double)

A háttérrendszeren lévő kérések feldolgozásához szükséges minimális idő.
subscriptionId

string

Előfizetés-azonosító elérési útja. /subscriptions/{subscriptionId}
timestamp

string (date-time)

Az összesítési időszak kezdete. A dátum a következő formátumnak felel meg: yyyy-MM-ddTHH:mm:ssZ az ISO 8601 szabványnak megfelelően.
userId

string

Felhasználói azonosító elérési útja. /users/{userId}
zip

string

Irányítószám, amelyhez ezek a rekordadatok kapcsolódnak.