GET схемы расширения - История изменений

IKuznetsov в 14:25, 24 декабря 2024

2024-12-24T14:25:09Z

← Предыдущая версия		Версия от 14:25, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [~~[API АппОптима~~#:~:text=DELETE ~~тегов~~-,~~Развёртывание~~,-~~править\|~~Развёртывание]] / [~~[API АппОптима~~#:~:text=GET ~~свойства события~~-,~~Расширения 2~~.0,-~~Конфигурации среды\|~~Расширения 2.0]] / [~~[API АппОптима~~#:~:text=GET ~~списка событий~~-,~~Расширения~~,-GET ~~всех расширений\|~~Расширения]] / GET схемы расширения'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%81%D0%B2%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F-,%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F%202.0,-%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8%20%D1%81%D1%80%D0%B5%D0%B4%D1%8B Расширения 2.0] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9-,%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D1%80%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D0%B9 Расширения] / GET схемы расширения'''''

	Функция получает схему указанной версии расширения Extensions 2.0.		Функция получает схему указанной версии расширения Extensions 2.0.

IKuznetsov в 13:21, 24 декабря 2024

2024-12-24T13:21:07Z

← Предыдущая версия		Версия от 13:21, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / [[API ~~Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B~~\|Эндпойнты среды]] / [[API ~~Ключ~~-~~АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5~~\|Развёртывание]] / Расширения 2.0 / ~~Раширения~~ / GET схемы расширения'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править\|Развёртывание]] / [[API АппОптима#:~:text=GET свойства события-,Расширения 2.0,-Конфигурации среды\|Расширения 2.0]] / [[API АппОптима#:~:text=GET списка событий-,Расширения,-GET всех расширений\|Расширения]] / GET схемы расширения'''''

	Функция получает схему указанной версии расширения Extensions 2.0.		Функция получает схему указанной версии расширения Extensions 2.0.
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
	\|-		\|-
Строка 745:		Строка 745:
	}		}
	}		}
	}~~</code>~~		}

IKuznetsov в 13:17, 24 декабря 2024

2024-12-24T13:17:01Z

← Предыдущая версия		Версия от 13:17, 24 декабря 2024
Строка 56:		Строка 56:
	!Описание		!Описание
	\|-		\|-
	\|~~AstromKey~~		\|AppOptima
	\|string		\|string
	\|Версия формата данных.		\|Версия формата данных.
Строка 687:		Строка 687:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"~~AstromKey~~": "1",		"AppOptima": "1",
	"schemaId": "builtin:container.built-in-monitoring-rule",		"schemaId": "builtin:container.built-in-monitoring-rule",
	"displayName": "Built-in container monitoring rules",		"displayName": "Built-in container monitoring rules",
	"description": "~~AstromKey~~ disables monitoring of containers that do not run any applications",		"description": "AppOptima disables monitoring of containers that do not run any applications",
	"documentation": "string",		"documentation": "string",
	"schemaGroups": [		"schemaGroups": [

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-21T16:07:11Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

Новая страница

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / Расширения 2.0 / Раширения / GET схемы расширения'''''

Функция получает схему указанной версии расширения Extensions 2.0.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение конфигураций мониторинга расширений''' ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|extensionName
|string
|Имя запрошенного расширения 2.0.
|path
|требуется
|-
|extensionVersion
|string
|Версия запрашиваемого расширения 2.0
|path
|требуется
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|SchemaDefinitionRestDto
|Успех
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}
===Объекты тела ответа===
====Объект <code>ResponseBody</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|AstromKey
|string
|Версия формата данных.
|-
|schemaId
|string
|Идентификатор схемы.
|-
|displayName
|string
|Отображаемое имя схемы.
|-
|description
|string
|Краткое описание схемы.
|-
|documentation
|string
|Расширенное описание схемы и/или ссылки на документацию.
Может быть <code>null</code>.
|-
|schemaGroups
|string[]
|Имена групп, которым принадлежит схема.
Может быть <code>null</code>.
|-
|version
|string
|Версия схемы.
|-
|multiObject
|boolean
|Допускается несколько ( <code>true</code>) объектов на область или один ( <code>false</code>) объект на область.
|-
|ordered
|boolean
|Если <code>true</code>порядок объектов имеет семантическое значение.
Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.

Может быть <code>null</code>.
|-
|maxObjects
|integer
|Максимальное количество объектов на область действия.
Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.
|-
|allowedScopes
|string[]
|Список областей, в которых можно использовать схему.
|-
|enums
|object
|Список определений свойств перечисления.
|-
|types
|object
|Список определений типов.
Тип — это сложное свойство, которое содержит собственный набор подсвойств.
|-
|properties
|object
|Список свойств схемы.
|-
|constraints
|ComplexConstraint[]
|Список ограничений, ограничивающих значения, принимаемые схемой.
Может быть <code>null</code>.
|-
|metadata
|object
|Метаданные настройки.
Может быть <code>null</code>.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
Может быть <code>null</code>.
|}
====Объект <code>EnumType</code>====
Определение перечислимого свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enumClass
|string
|Существующий класс перечисления Java, который содержит допустимые значения перечисления.
Может быть <code>null</code>.
|-
|items
|EnumValue[]
|Список допустимых значений перечисления.
|-
|type
|string
|Тип свойства.
Элемент может содержать эти значения
*<code>enum</code>
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|displayName
|string
|Отображаемое имя свойства.
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание недвижимости.
|}
====Объект <code>EnumValue</code>====
Допустимое значение для перечислимого свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enumInstance
|string
|Имя значения в существующем классе перечисления Java.
Может быть <code>null</code>.
|-
|icon
|string
|Значок значения.
Может быть <code>null</code>.
|-
|value
|object
|Допустимое значение перечисления.
|-
|displayName
|string
|Отображаемое имя значения.
|-
|description
|string
|Краткое описание ценности.
Может быть <code>null</code>.
|}
====Объект <code>SchemaType</code>====
Список определений типов.

Тип — это сложное свойство, которое содержит собственный набор подсвойств.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|summaryPattern
|string
|Шаблон для сводки (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.
|-
|searchPattern
|string
|Шаблон для сводного поиска (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.
Может быть <code>null</code>.
|-
|versionInfo
|string
|Краткое описание версии.
Может быть <code>null</code>.
|-
|version
|string
|Версия типа.
|-
|properties
|object
|Определение свойств, которые могут быть сохранены.
|-
|constraints
|ComplexConstraint[]
|Список ограничений, ограничивающих допустимые значения.
Может быть <code>null</code>.
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|displayName
|string
|Отображаемое имя свойства.
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание ценности.
|}
====Объект <code>PropertyDefinition</code>====
Конфигурация свойства в схеме настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|referencedType
|string
|Тип, на который ссылается значение свойства
Может быть <code>null</code>.
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
Может быть <code>null</code>.
|-
|maxObjects
|integer
|Максимальное количество объектов в свойстве коллекции.
Имеет значение <code>1</code>для синглетонов.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
Может быть <code>null</code>.
|-
|precondition
|Precondition
|Предварительное условие видимости свойства.
Может быть <code>null</code>.
|-
|datasource
|DatasourceDefinition
|Конфигурация источника данных для свойства.
Может быть <code>null</code>.
|-
|minObjects
|integer
|Минимальное количество объектов в свойстве коллекции.
Может быть <code>null</code>.
|-
|modificationPolicy
|string
|Политика модификации свойства.
Элемент может содержать эти значения
*<code>ALWAYS</code>
*<code>DEFAULT</code>
*<code>NEVER</code>
Может быть <code>null</code>.
|-
|items
|Item
|Элемент свойства коллекции.
Может быть <code>null</code>.
|-
|subType
|string
|Подтип значения свойства.
Может быть <code>null</code>.
|-
|default
|object
|Значение по умолчанию, которое будет использоваться, если значение не указано.
Если не-синглтон имеет значение <code>null</code>, это означает пустую коллекцию.

Может быть <code>null</code>.
|-
|type
|object
|Тип значения свойства.
|-
|displayName
|string
|Отображаемое имя свойства.
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание недвижимости.
Может быть <code>null</code>.
|-
|metadata
|object
|Метаданные свойства.
Может быть <code>null</code>.
|-
|constraints
|Constraint[]
|Список ограничений, ограничивающих допустимые значения.
Может быть <code>null</code>.
|-
|nullable
|boolean
|Значение может ( <code>true</code>) или не может ( <code>false</code>) быть <code>null</code>.
|}
====Объект <code>UiCustomization</code>====
Настройка элементов пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|expandable
|UiExpandableCustomization
|Настройка пользовательского интерфейса для расширяемого раздела
Может быть <code>null</code>.
|-
|table
|UiTableCustomization
|Настройка таблиц пользовательского интерфейса
Может быть <code>null</code>.
|}
====Объект <code>UiExpandableCustomization</code>====
Настройка пользовательского интерфейса для расширяемого раздела
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|displayName
|string
|Отображаемое имя
Может быть <code>null</code>.
|-
|sections
|UiExpandableSectionCustomization[]
|Список разделов
Может быть <code>null</code>.
|}
====Объект <code>UiExpandableSectionCustomization</code>====
Настройка расширяемого раздела для пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|properties
|string[]
|Список свойств
|-
|displayName
|string
|Отображаемое имя
|-
|description
|string
|Описание
Может быть <code>null</code>.
|}
====Объект <code>UiTableCustomization</code>====
Настройка таблиц пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|columns
|UiTableColumnCustomization[]
|Список столбцов для таблицы пользовательского интерфейса
Может быть <code>null</code>.
|}
====Объект <code>UiTableColumnCustomization</code>====
Настройка столбцов таблицы пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|builtinColumnRef
|string
|Индивидуальная встроенная реализация столбца пользовательского интерфейса для этого столбца.
Может быть <code>null</code>.
|-
|propertyRef
|string
|Свойство, на которое указывает ссылка, для этого столбца.
Может быть <code>null</code>.
|-
|type
|string
|Конкретный тип пользовательского интерфейса для этого столбца.
Может быть <code>null</code>.
|-
|displayName
|string
|Отображаемое имя для этого столбца.
Может быть <code>null</code>.
|}
====Объект <code>Precondition</code>====
Предварительное условие видимости свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|expectedValue
|object
|Ожидаемая стоимость объекта.
Применимо только к свойствам <code>EQUALS</code>типа.

Может быть <code>null</code>.
|-
|expectedValues
|object[]
|Список допустимых значений свойства.
Применимо только к свойствам <code>IN</code>типа.

Может быть <code>null</code>.
|-
|precondition
|Precondition
|Предварительное условие видимости свойства.
Может быть <code>null</code>.
|-
|preconditions
|Precondition[]
|Список дочерних предварительных условий для оценки.
Применимо только к свойствам типов <code>AND</code>и <code>OR</code>.

Может быть <code>null</code>.
|-
|property
|string
|Объект оценки.
Может быть <code>null</code>.
|-
|type
|string
|Тип предварительного условия.
Элемент может содержать эти значения
|-
|pattern
|string
|Регулярное выражение, которое сопоставляется со свойством.
Применимо только к свойствам <code>REGEX_MATCH</code>типа.

Может быть <code>null</code>.
|}
====Объект <code>DatasourceDefinition</code>====
Конфигурация источника данных для свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|resetValue
|string
|Когда сбрасывать значение источника данных в пользовательском интерфейсе при изменении фильтра.
Элемент может содержать эти значения
*<code>ALWAYS</code>
*<code>INVALID_ONLY</code>
*<code>NEVER</code>
Может быть <code>null</code>.
|-
|свойства фильтра
|string[]
|Свойства для фильтрации параметров источника данных.
|-
|подтверждать
|boolean
|Следует ли проверять ввод, чтобы разрешить только значения, возвращаемые источником данных.
|-
|полныйконтекст
|boolean
|Ожидает ли этот источник данных полную настройку полезной нагрузки в качестве контекста.
|-
|useApiSearch
|boolean
|Если это правда, источник данных должен использовать API для фильтрации результатов вместо фильтрации на стороне клиента.
|-
|идентификатор
|string
|Идентификатор пользовательского источника данных значения свойства.
|}
====Объект <code>Item</code>====
Элемент свойства коллекции.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|referencedType
|string
|Тип, на который ссылается значение элемента.
Может быть <code>null</code>.
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
Может быть <code>null</code>.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
Может быть <code>null</code>.
|-
|datasource
|DatasourceDefinition
|Конфигурация источника данных для свойства.
Может быть <code>null</code>.
|-
|subType
|string
|Подтип значения элемента.
Может быть <code>null</code>.
|-
|type
|object
|Тип значения элемента.
|-
|displayName
|string
|Отображаемое имя элемента.
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание предмета.
Может быть <code>null</code>.
|-
|metadata
|object
|Метаданные предметов.
Может быть <code>null</code>.
|-
|constraints
|Constraint[]
|Список ограничений, ограничивающих допустимые значения.
Может быть <code>null</code>.
|}
====Объект <code>Constraint</code>====
Ограничение на значения, принимаемые для свойства настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|maxLength
|integer
|Максимально допустимая длина строковых значений.
Может быть <code>null</code>.
|-
|minLength
|integer
|Минимальная требуемая длина строковых значений.
Может быть <code>null</code>.
|-
|uniqueProperties
|string[]
|Список свойств, для которых комбинация значений должна быть уникальной.
Может быть <code>null</code>.
|-
|customMessage
|srting
|Пользовательское сообщение для недопустимых значений.
Может быть <code>null</code>.
|-
|customValidatorId
|srting
|Идентификатор пользовательского валидатора.
Может быть <code>null</code>.
|-
|maximum
|number
|Максимально допустимое значение.
Может быть <code>null</code>.
|-
|minimum
|number
|Минимально допустимое значение.
Может быть <code>null</code>.
|-
|тип
|srting
|Тип ограничения.
Элемент может содержать эти значения
*<code>CUSTOM_VALIDATOR_REF</code>
*<code>LENGTH</code>
*<code>NOT_BLANK</code>
*<code>NOT_EMPTY</code>
*<code>NO_WHITESPACE</code>
*<code>PATTERN</code>
*<code>RANGE</code>
*<code>REGEX</code>
*<code>TRIMMED</code>
*<code>UNIQUE</code>
*<code>UNKNOWN</code>
|-
|pattern
|srting
|Шаблон регулярного выражения для допустимых строковых значений.
Может быть <code>null</code>.
|}
====Объект <code>ComplexConstraint</code>====
Ограничение на значения, принимаемые для сложного свойства настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|customMessage
|string
|Пользовательское сообщение для недопустимых значений.
Может быть <code>null</code>.
|-
|customValidatorId
|string
|Идентификатор пользовательского валидатора.
Может быть <code>null</code>.
|-
|minimumPropertyCount
|integer
|Минимальное количество свойств, которые необходимо установить.
Может быть <code>null</code>.
|-
|maximumPropertyCount
|integer
|Максимальное количество свойств, которые можно установить.
Может быть <code>null</code>.
|-
|properties
|string[]
|Список свойств (определяемых идентификаторами), которые используются для проверки ограничения.
Может быть <code>null</code>.
|-
|type
|string
|Тип ограничения.
Элемент может содержать эти значения
*<code>CUSTOM_VALIDATOR_REF</code>
*<code>GREATER_THAN</code>
*<code>GREATER_THAN_OR_EQUAL</code>
*<code>LESS_THAN</code>
*<code>LESS_THAN_OR_EQUAL</code>
*<code>PROPERTY_COUNT_RANGE</code>
*<code>UNKNOWN</code>
|}
===JSON-модель тела ответа===
<code>{
"AstromKey": "1",
"schemaId": "builtin:container.built-in-monitoring-rule",
"displayName": "Built-in container monitoring rules",
"description": "AstromKey disables monitoring of containers that do not run any applications",
"documentation": "string",
"schemaGroups": [
"group:some.1",
"group:some.2"
],
"version": "1.4.2",
"multiObject": true,
"ordered": true,
"maxObjects": 10,
"allowedScopes": [
"host",
"application"
],
"enums": {},
"types": {},
"properties": {},
"constraints": [
{
"customMessage": "string",
"customValidatorId": "my-min-max",
"minimumPropertyCount": 1,
"maximumPropertyCount": 2,
"properties": [
"string"
],
"type": "CUSTOM_VALIDATOR_REF"
}
],
"metadata": {},
"uiCustomization": {
"expandable": {
"displayName": "string",
"sections": [
{
"properties": [
"string"
],
"displayName": "string",
"description": "string"
}
]
},
"table": {
"columns": [
{
"builtinColumnRef": "summary",
"propertyRef": "apiColor",
"type": "cell-color-picker",
"displayName": "Color"
}
]
}
}
}</code>