Metadata - Post

Служба:: Application Insights

Версия API:: v1

Возвращает сведения о метаданных
Получение сведений о метаданных для приложения, включая ее схему и т. д.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
appId	path	True	string	Идентификатор приложения. Это идентификатор приложения из колонки параметров доступа к API на портале Azure.

Ответы

Имя	Тип	Описание
200 OK	metadataResults	Успешный ответ
Other Status Codes	errorResponse	Объект ответа об ошибке.

Безопасность

oauth2

Подключение к API Azure Application Insights

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

metadataPost

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
Columns	Список столбцов, определенных в таблице
errorDetail	Сведения об ошибке.
errorInfo	Код и сообщение об ошибке.
errorResponse	Сведения об ошибке.
metadataApplication	Приложение Application Insights.
MetadataColumnDataType	Тип данных столбца
metadataFunction	Хранимая функция.
metadataResults	Ответ метаданных.
metadataTable	Таблица данных, которая участвует в схеме приложения Application Insights.
metadataTableGroup	Группа таблиц.

Columns

Object

Список столбцов, определенных в таблице

Имя	Тип	Описание
description	string	Описание столбца
isPreferredFacet	boolean	Флаг, указывающий, что этот столбец является предпочтительным аспектом
name	string	Имя столбца
source	object	указание источника столбца, используемого только в том случае, если несколько приложений имеют конфликтующее определение столбца
type	MetadataColumnDataType	Тип данных столбца

errorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalProperties	object
code	string	Код ошибки.
message	string	Сообщение об ошибке, доступное для чтения.
resources	string[]	Указывает ресурсы, ответственные за ошибку.
target	string	Указывает, какое свойство в запросе отвечает за ошибку.
value	string	Указывает, какое значение в target отвечает за ошибку.

errorInfo

Object

Код и сообщение об ошибке.

Имя	Тип	Описание
additionalProperties	object
code	string	Код ошибки, доступный для чтения компьютером.
details	errorDetail[]	сведения об ошибке.
innererror	errorInfo	Код и сообщение об ошибке. Сведения о внутренней ошибке, если они существуют.
message	string	Сообщение об ошибке, доступное для чтения.

errorResponse

Object

Сведения об ошибке.

Имя	Тип	Описание
error	errorInfo	Код и сообщение об ошибке. Сведения об ошибке.

metadataApplication

Object

Приложение Application Insights.

Имя	Тип	Описание
functions	string[]	Список хранимых функций в приложении Application Insights
id	string	Идентификатор приложения Application Insights.
name	string	Имя приложения Application Insights.
region	string	Регион Azure приложения Application Insights.
resourceId	string	Идентификатор ресурса ARM приложения Application Insights.
tableGroups	string[]	Список групп таблиц в приложении Application Insights
tables	string[]	Список пользовательских таблиц для приложения Application Insights.

MetadataColumnDataType

Перечисление

Тип данных столбца

Значение	Описание
bool
datetime
dynamic
int
long
real
string

metadataFunction

Object

Хранимая функция.

Имя	Тип	Описание
body	string	Текст KQL функции.
description	string	Описание функции.
displayName	string	Отображаемое имя функции.
id	string	Идентификатор функции.
name	string	Имя функции, используемой в запросах.
parameters	string	Параметры и аргументы функции, если таковые есть.

metadataResults

Object

Ответ метаданных.

Имя	Тип	Описание
applications	metadataApplication[]	Список приложений Application Insights, на которые ссылались в запросе метаданных.
functions	metadataFunction[]	Список функций, хранящихся в приложении.
tableGroups	metadataTableGroup[]	Список групп таблиц в приложении.
tables	metadataTable[]	Список таблиц и столбцов, составляющих схему приложения.

metadataTable

Object

Таблица данных, которая участвует в схеме приложения Application Insights.

Имя	Тип	Описание
columns	Columns[]	Список столбцов, определенных в таблице
description	string	Описание таблицы
id	string	Идентификатор таблицы
name	string	Имя таблицы.
timespanColumn	string	Столбец, связанный с параметром запроса timepan для таблицы

metadataTableGroup

Object

Группа таблиц.

Имя	Тип	Описание
description	string	Описание группы таблиц
displayName	string	Отображаемое имя группы таблиц
id	string	Идентификатор группы таблиц
name	string	Имя группы таблиц
source	string	Источником группы таблиц может быть ИИ или OMS для рабочих областей Log Analytics.
tables	string[]	Список таблиц, содержащихся в группе таблиц