Udostępnij za pośrednictwem


Metadata - Post

Pobiera informacje o metadanych
Pobierz informacje o metadanych dla aplikacji, w tym jej schemat itp.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
appId
path True

string

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

Odpowiedzi

Nazwa Typ Opis
200 OK

metadataResults

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

metadataPost

Przykładowe żądanie

POST https://api.applicationinsights.io/v1/apps/cf58dcfd-0683-487c-bc84-048789bca8e5/metadata

Przykładowa odpowiedź

{
  "tables": [
    {
      "id": "t/requests",
      "name": "requests",
      "timespanColumn": "timestamp",
      "columns": [
        {
          "name": "timestamp",
          "type": "datetime"
        },
        {
          "name": "id",
          "type": "string"
        },
        {
          "name": "source",
          "type": "string"
        },
        {
          "name": "name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "url",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "success",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "resultCode",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "duration",
          "type": "real"
        },
        {
          "name": "performanceBucket",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "itemType",
          "type": "string"
        },
        {
          "name": "customDimensions",
          "type": "dynamic",
          "isPreferredFacet": true
        },
        {
          "name": "customMeasurements",
          "type": "dynamic"
        },
        {
          "name": "operation_Name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "operation_Id",
          "type": "string"
        },
        {
          "name": "operation_ParentId",
          "type": "string"
        },
        {
          "name": "operation_SyntheticSource",
          "type": "string"
        },
        {
          "name": "session_Id",
          "type": "string"
        },
        {
          "name": "user_Id",
          "type": "string"
        },
        {
          "name": "user_AuthenticatedId",
          "type": "string"
        },
        {
          "name": "user_AccountId",
          "type": "string"
        },
        {
          "name": "application_Version",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "client_Type",
          "type": "string"
        },
        {
          "name": "client_Model",
          "type": "string"
        },
        {
          "name": "client_OS",
          "type": "string"
        },
        {
          "name": "client_IP",
          "type": "string"
        },
        {
          "name": "client_City",
          "type": "string"
        },
        {
          "name": "client_StateOrProvince",
          "type": "string"
        },
        {
          "name": "client_CountryOrRegion",
          "type": "string"
        },
        {
          "name": "client_Browser",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleInstance",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "appId",
          "type": "string"
        },
        {
          "name": "appName",
          "type": "string"
        },
        {
          "name": "iKey",
          "type": "string"
        },
        {
          "name": "sdkVersion",
          "type": "string"
        },
        {
          "name": "itemId",
          "type": "string"
        },
        {
          "name": "itemCount",
          "type": "int"
        }
      ]
    }
  ],
  "tableGroups": [
    {
      "id": "ai/StandardSchema",
      "name": "StandardSchema",
      "source": "ai",
      "tables": [
        "t/requests"
      ]
    }
  ],
  "applications": [
    {
      "id": "cf58dcfd-0683-487c-bc84-048789bca8e5",
      "name": "FabrikamProd",
      "resourceId": "/subscriptions/72993b69-db12-44fc-9a66-9c2005c30513/resourceGroups/Fabrikam/providers/microsoft.insights/components/FabrikamProd",
      "tables": [],
      "region": "southcentralus",
      "tableGroups": [
        "ai/StandardSchema"
      ]
    }
  ]
}

Definicje

Nazwa Opis
Columns

Lista kolumn zdefiniowanych w tabeli

errorDetail

Szczegóły błędu.

errorInfo

Kod i komunikat dotyczący błędu.

errorResponse

Szczegóły błędu.

metadataApplication

Aplikacja usługi Application Insights.

MetadataColumnDataType

Typ danych kolumny

metadataFunction

Przechowywana funkcja.

metadataResults

Odpowiedź na metadane.

metadataTable

Tabela danych, która bierze udział w schemacie aplikacji usługi Application Insights.

metadataTableGroup

Grupa tabel.

Columns

Lista kolumn zdefiniowanych w tabeli

Nazwa Typ Opis
description

string

Opis kolumny

isPreferredFacet

boolean

Flaga wskazująca, że ta kolumna jest preferowanym aspektem

name

string

Nazwa kolumny

source

object

wskazanie źródła kolumny, używane tylko wtedy, gdy wiele aplikacji ma definicję powodującą konflikt dla kolumny

type

MetadataColumnDataType

Typ danych kolumny

errorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalProperties

object

code

string

Kod błędu.

message

string

Komunikat o błędzie czytelny dla człowieka.

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

Komunikat o błędzie czytelny dla człowieka.

errorResponse

Szczegóły błędu.

Nazwa Typ Opis
error

errorInfo

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

metadataApplication

Aplikacja usługi Application Insights.

Nazwa Typ Opis
functions

string[]

Lista przechowywanych funkcji w aplikacji Usługi Application Insights

id

string

Identyfikator aplikacji Usługi Application Insights.

name

string

Nazwa aplikacji Usługi Application Insights.

region

string

Region platformy Azure aplikacji Application Insights.

resourceId

string

Identyfikator zasobu usługi ARM aplikacji Application Insights.

tableGroups

string[]

Lista grup tabel w aplikacji Usługi Application Insights

tables

string[]

Lista tabel niestandardowych dla aplikacji Application Insights.

MetadataColumnDataType

Typ danych kolumny

Nazwa Typ Opis
bool

string

datetime

string

dynamic

string

int

string

long

string

real

string

string

string

metadataFunction

Przechowywana funkcja.

Nazwa Typ Opis
body

string

Treść funkcji KQL.

description

string

Opis funkcji.

displayName

string

Nazwa wyświetlana funkcji.

id

string

Identyfikator funkcji.

name

string

Nazwa funkcji, która ma być używana w zapytaniach.

parameters

string

Parametry/argumenty funkcji, jeśli istnieją.

metadataResults

Odpowiedź na metadane.

Nazwa Typ Opis
applications

metadataApplication[]

Lista aplikacji usługi Application Insights, do których odwołuje się żądanie metadanych.

functions

metadataFunction[]

Lista funkcji przechowywanych w aplikacji.

tableGroups

metadataTableGroup[]

Lista grup tabel w aplikacji.

tables

metadataTable[]

Lista tabel i kolumn składających się na schemat aplikacji.

metadataTable

Tabela danych, która bierze udział w schemacie aplikacji usługi Application Insights.

Nazwa Typ Opis
columns

Columns[]

Lista kolumn zdefiniowanych w tabeli

description

string

Opis tabeli

id

string

Identyfikator tabeli

name

string

Nazwa tabeli

timespanColumn

string

Kolumna skojarzona z parametrem zapytania przedziału czasu dla tabeli

metadataTableGroup

Grupa tabel.

Nazwa Typ Opis
description

string

Opis grupy tabel

displayName

string

Nazwa wyświetlana grupy tabel

id

string

Identyfikator grupy tabel

name

string

Nazwa grupy tabel

source

string

Źródłem grupy tabel może być sztuczna inteligencja lub usługa OMS dla obszarów roboczych usługi Log Analytics

tables

string[]

Lista tabel zawartych w grupie tabel