Udostępnij za pośrednictwem


Metrics - Get Multiple

Pobieranie danych metryk
Pobiera wartości metryk dla wielu metryk

POST https://api.applicationinsights.io/v1/apps/{appId}/metrics

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
appId
path True

string

Identyfikator aplikacji. Jest to identyfikator aplikacji w bloku Ustawień dostępu do interfejsu API w Azure Portal.

Treść żądania

Nazwa Typ Opis
body

metricsPostBodySchema[]

Zapytanie dotyczące metryk wsadowych.

Odpowiedzi

Nazwa Typ Opis
200 OK

metricsResults[]

Pomyślna odpowiedź

Other Status Codes

errorResponse

Obiekt odpowiedzi o błędzie.

Zabezpieczenia

oauth2

Nawiązywanie połączenia z interfejsem API usługi aplikacja systemu Azure Insights

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

postMetric

Przykładowe żądanie

POST https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics

[
  {
    "id": "failed",
    "parameters": {
      "metricId": "requests/failed",
      "timespan": "P2D",
      "interval": "P1D"
    }
  },
  {
    "id": "count",
    "parameters": {
      "metricId": "requests/count",
      "timespan": "P2D",
      "interval": "P1D"
    }
  }
]

Przykładowa odpowiedź

[
  {
    "id": "failed",
    "status": 200,
    "body": {
      "value": {
        "start": "2018-01-22T19:59:12.488Z",
        "end": "2018-01-24T19:59:12.488Z",
        "interval": "P1D",
        "segments": [
          {
            "start": "2018-01-22T19:59:12.488Z",
            "end": "2018-01-23T00:00:00.000Z",
            "requests/failed": {
              "sum": 277
            }
          },
          {
            "start": "2018-01-23T00:00:00.000Z",
            "end": "2018-01-24T00:00:00.000Z",
            "requests/failed": {
              "sum": 1599
            }
          },
          {
            "start": "2018-01-24T00:00:00.000Z",
            "end": "2018-01-24T19:59:12.488Z",
            "requests/failed": {
              "sum": 1392
            }
          }
        ]
      }
    }
  },
  {
    "id": "count",
    "status": 200,
    "body": {
      "value": {
        "start": "2018-01-22T19:59:12.488Z",
        "end": "2018-01-24T19:59:12.488Z",
        "interval": "P1D",
        "segments": [
          {
            "start": "2018-01-22T19:59:12.488Z",
            "end": "2018-01-23T00:00:00.000Z",
            "requests/count": {
              "sum": 1225
            }
          },
          {
            "start": "2018-01-23T00:00:00.000Z",
            "end": "2018-01-24T00:00:00.000Z",
            "requests/count": {
              "sum": 7382
            }
          },
          {
            "start": "2018-01-24T00:00:00.000Z",
            "end": "2018-01-24T19:59:12.488Z",
            "requests/count": {
              "sum": 6674
            }
          }
        ]
      }
    }
  }
]

Definicje

Nazwa Opis
errorDetail

Szczegóły błędu.

errorInfo

Kod i komunikat dotyczący błędu.

errorResponse

Szczegóły błędu.

MetricId

Identyfikator metryki. Jest to standardowa metryka sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.

MetricsAggregation

Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, oddziel je przecinkiem. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.

metricsPostBodySchema

Żądanie metryki

metricsResult

Wynik metryki.

metricsResultInfo

Dane wyniku metryki.

metricsResults

Zestaw wyników metryk.

MetricsSegment

Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty według więcej niż jednego wymiaru naraz, oddziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .

metricsSegmentInfo

Segment metryki

Parameters

Parametry dla pojedynczego zapytania metryk

errorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalProperties

object

code

string

Kod błędu.

message

string

Czytelny dla człowieka komunikat o błędzie.

resources

string[]

Wskazuje zasoby, które były odpowiedzialne za błąd.

target

string

Wskazuje, która właściwość w żądaniu jest odpowiedzialna za błąd.

value

string

Wskazuje, która wartość w elemecie "target" jest odpowiedzialna za błąd.

errorInfo

Kod i komunikat dotyczący błędu.

Nazwa Typ Opis
additionalProperties

object

code

string

Kod błędu z możliwością odczytu maszyny.

details

errorDetail[]

szczegóły błędu.

innererror

errorInfo

Kod i komunikat dotyczący błędu.
Szczegóły błędu wewnętrznego, jeśli istnieją.

message

string

Czytelny dla człowieka komunikat o błędzie.

errorResponse

Szczegóły błędu.

Nazwa Typ Opis
error

errorInfo

Kod i komunikat dotyczący błędu.
Szczegóły błędu.

MetricId

Identyfikator metryki. Jest to standardowa metryka sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.

Nazwa Typ Opis
availabilityResults/availabilityPercentage

string

availabilityResults/duration

string

billing/telemetryCount

string

client/networkDuration

string

client/processingDuration

string

client/receiveDuration

string

client/sendDuration

string

client/totalDuration

string

customEvents/count

string

dependencies/count

string

dependencies/duration

string

dependencies/failed

string

exceptions/browser

string

exceptions/count

string

exceptions/server

string

pageViews/count

string

pageViews/duration

string

performanceCounters/exceptionsPerSecond

string

performanceCounters/memoryAvailableBytes

string

performanceCounters/processCpuPercentage

string

performanceCounters/processIOBytesPerSecond

string

performanceCounters/processPrivateBytes

string

performanceCounters/processorCpuPercentage

string

performanceCounters/requestExecutionTime

string

performanceCounters/requestsInQueue

string

performanceCounters/requestsPerSecond

string

requests/count

string

requests/duration

string

requests/failed

string

sessions/count

string

users/authenticated

string

users/count

string

MetricsAggregation

Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, oddziel je przecinkiem. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.

Nazwa Typ Opis
avg

string

count

string

max

string

min

string

sum

string

unique

string

metricsPostBodySchema

Żądanie metryki

Nazwa Typ Opis
id

string

Identyfikator dla tego zapytania. Musi być unikatowa w treści żądania. Ten identyfikator będzie właściwością "id" obiektu odpowiedzi reprezentującego to zapytanie.

parameters

Parameters

Parametry dla pojedynczego zapytania metryk

metricsResult

Wynik metryki.

Nazwa Typ Opis
value

metricsResultInfo

Dane wyniku metryki.

metricsResultInfo

Dane wyniku metryki.

Nazwa Typ Opis
end

string

Godzina rozpoczęcia metryki.

interval

string

Interwał używany do segmentowania danych metryk.

segments

metricsSegmentInfo[]

Segmentowane dane metryk (jeśli są podzielone na segmenty).

start

string

Godzina rozpoczęcia metryki.

metricsResults

Zestaw wyników metryk.

Nazwa Typ Opis
body

metricsResult

Wyniki tego zapytania metryki.

id

string

Określony identyfikator dla tej metryki.

status

integer

Kod stanu HTTP tego zapytania metryki.

MetricsSegment

Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty według więcej niż jednego wymiaru naraz, oddziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .

Nazwa Typ Opis
applicationBuild

string

applicationVersion

string

authenticatedOrAnonymousTraffic

string

browser

string

browserVersion

string

city

string

cloudRoleName

string

cloudServiceName

string

continent

string

countryOrRegion

string

deploymentId

string

deploymentUnit

string

deviceType

string

environment

string

hostingLocation

string

instanceName

string

metricsSegmentInfo

Segment metryki

Nazwa Typ Opis
end

string

Godzina rozpoczęcia segmentu metryki (tylko wtedy, gdy określono interwał).

segments

metricsSegmentInfo[]

Segmentowane dane metryk (jeśli są dalej podzielone na segmenty).

start

string

Godzina rozpoczęcia segmentu metryki (tylko wtedy, gdy określono interwał).

Parameters

Parametry dla pojedynczego zapytania metryk

Nazwa Typ Opis
aggregation

MetricsAggregation[]

Agregacja do użycia podczas obliczania wartości metryk. Aby pobrać więcej niż jedną agregację jednocześnie, oddziel je przecinkiem. Jeśli nie określono agregacji, zostanie użyta domyślna agregacja dla metryki.

filter

string

Wyrażenie używane do filtrowania wyników. Ta wartość powinna być prawidłowym wyrażeniem filtru OData, w którym klucze każdej klauzuli powinny mieć zastosowanie do wymiarów metryki, którą pobierasz.

interval

string

Interwał czasu, który ma być używany podczas pobierania wartości metryk. Jest to czas trwania ISO8601. Jeśli interwał zostanie pominięty, wartość metryki jest agregowana w całym przedziale czasu. Jeśli podano interwał, serwer może dostosować interwał do bardziej odpowiedniego rozmiaru na podstawie przedziału czasu używanego dla zapytania. We wszystkich przypadkach rzeczywisty interwał używany dla zapytania jest uwzględniany w odpowiedzi.

metricId

MetricId

Identyfikator metryki. Jest to standardowa metryka sztucznej inteligencji lub metryka niestandardowa specyficzna dla aplikacji.

orderby

string

Funkcja agregacji i kierunek sortowania segmentów według. Ta wartość jest prawidłowa tylko wtedy, gdy określono segment.

segment

MetricsSegment[]

Nazwa wymiaru do segmentowania wartości metryk według. Ten wymiar musi mieć zastosowanie do metryki, którą pobierasz. Aby podzielić segmenty według więcej niż jednego wymiaru naraz, oddziel je przecinkiem (,). W takim przypadku dane metryk zostaną podzielone na segmenty w kolejności, w którym wymiary są wymienione w parametrze .

timespan

string

Przedział czasu pobierania wartości metryk. Jest to wartość okresu ISO8601. Jeśli przedział czasu zostanie pominięty, zostanie użyty domyślny zakres PT12H czasu ("ostatnie 12 godzin"). Rzeczywiste przedziały czasu, które są odpytywane, mogą być dostosowywane przez serwer oparty na serwerze. We wszystkich przypadkach rzeczywisty przedział czasu używany dla zapytania jest uwzględniony w odpowiedzi.

top

integer

Liczba segmentów do zwrócenia. Ta wartość jest prawidłowa tylko wtedy, gdy określono segment.