Получение схемы расширения
Функция получает схему указанной версии расширения Extensions 2.0.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema
|
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema
| |
Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
extensionVersion | string | Версия запрашиваемого расширения 2.0 | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | SchemaDefinitionRestDto | Успех |
404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект _ ResponseBody
Элемент | Тип | Описание |
---|---|---|
Dynatrace | string | Версия формата данных. |
schemaId | string | Идентификатор схемы. |
displayName | string | Отображаемое имя схемы. |
description | string | Краткое описание схемы. |
documentation | string | Расширенное описание схемы и/или ссылки на документацию.
Может быть |
schemaGroups | string[] | Имена групп, которым принадлежит схема.
Может быть |
version | string | Версия схемы. |
multiObject | boolean | Допускается несколько ( true ) объектов на область или один ( false ) объект на область.
|
ordered | boolean | Если true порядок объектов имеет семантическое значение.
Применимо только в том случае, если для параметра multiObject установлено значение Может быть |
maxObjects | integer | Максимальное количество объектов на область действия.
Применимо только в том случае, если для параметра multiObject установлено значение |
allowedScopes | string[] | Список областей, в которых можно использовать схему. |
enums | object | Список определений свойств перечисления. |
types | object | Список определений типов.
Тип — это сложное свойство, которое содержит собственный набор подсвойств. |
properties | object | Список свойств схемы. |
constraints | ComplexConstraint[] | Список ограничений, ограничивающих значения, принимаемые схемой.
Может быть |
metadata | object | Метаданные настройки.
Может быть |
uiCustomization | UiCustomization | Настройка элементов пользовательского интерфейса
Может быть |
Объект EnumType
Определение перечислимого свойства.
Элемент | Тип | Описание |
---|---|---|
enumClass | string | Существующий класс перечисления Java, который содержит допустимые значения перечисления.
Может быть |
items | EnumValue[] | Список допустимых значений перечисления. |
type | string | Тип свойства.
Элемент может содержать эти значения
|
documentation | string | Расширенное описание и/или ссылки на документацию. |
displayName | string | Отображаемое имя свойства.
Может быть |
description | string | Краткое описание недвижимости. |
Объект EnumValue
Допустимое значение для перечислимого свойства.
Элемент | Тип | Описание |
---|---|---|
enumInstance | string | Имя значения в существующем классе перечисления Java.
Может быть |
icon | string | Значок значения.
Может быть |
value | object | Допустимое значение перечисления. |
displayName | string | Отображаемое имя значения. |
description | string | Краткое описание стоимости.
Может быть |
Объект SchemaType
Список определений типов.
Тип — это сложное свойство, которое содержит собственный набор подсвойств.
Элемент | Тип | Описание |
---|---|---|
summaryPattern | string | Шаблон для сводки (например, «Предупреждение через X минут») конфигурации в пользовательском интерфейсе. |
searchPattern | string | Шаблон для сводного поиска (например, «Предупреждение через X минут») конфигурации в пользовательском интерфейсе.
Может быть |
versionInfo | string | Краткое описание версии.
Может быть |
version | string | Версия типа. |
properties | object | Определение свойств, которые могут быть сохранены. |
constraints | ComplexConstraint[] | Список ограничений, ограничивающих допустимые значения.
Может быть |
documentation | string | Расширенное описание и/или ссылки на документацию. |
displayName | string | Отображаемое имя свойства.
Может быть |
description | string | Краткое описание недвижимости. |
Объект PropertyDefinition
Конфигурация свойства в схеме настроек.
Элемент | Тип | Описание |
---|---|---|
referencedType | string | Тип, на который ссылается значение свойства
Может быть |
documentation | string | Расширенное описание и/или ссылки на документацию.
Может быть |
maxObjects | integer | Максимальное количество объектов в свойстве коллекции.
Имеет значение |
uiCustomization | UiCustomization | Настройка элементов пользовательского интерфейса
Может быть |
precondition | Precondition | Предварительное условие видимости свойства.
Может быть |
datasource | DatasourceDefinition | Конфигурация источника данных для свойства.
Может быть |
minObjects | integer | Минимальное количество объектов в свойстве коллекции.
Может быть |
modificationPolicy | string | Политика модификации свойства.
Элемент может содержать эти значения
Может быть |
items | Item | Элемент свойства коллекции.
Может быть |
subType | string | Подтип значения свойства.
Может быть |
default | object | Значение по умолчанию, которое будет использоваться, если значение не указано.
Если не-синглтон имеет значение Может быть |
type | object | Тип значения свойства. |
displayName | string | Отображаемое имя свойства.
Может быть |
description | string | Краткое описание недвижимости.
Может быть |
metadata | object | Метаданные свойства.
Может быть |
constraints | Constraint[] | Список ограничений, ограничивающих допустимые значения.
Может быть |
nullable | boolean | Значение может ( true ) или не может ( false ) быть null .
|
Объект UiCustomization
Настройка элементов пользовательского интерфейса
Элемент | Тип | Описание |
---|---|---|
expandable | UiExpandableCustomization | Настройка пользовательского интерфейса для расширяемого раздела
Может быть |
table | UiTableCustomization | Настройка таблиц пользовательского интерфейса
Может быть |
Объект UiExpandableCustomization
Настройка пользовательского интерфейса для расширяемого раздела
Элемент | Тип | Описание |
---|---|---|
displayName | string | Отображаемое имя
Может быть |
sections | UiExpandableSectionCustomization[] | Список разделов
Может быть |
Объект UiExpandableSectionCustomization
Настройка расширяемого раздела для пользовательского интерфейса
Элемент | Тип | Описание |
---|---|---|
properties | string[] | Список свойств |
displayName | string | Отображаемое имя |
description | string | Описание
Может быть |
Объект UiTableCustomization
Настройка таблиц пользовательского интерфейса
Элемент | Тип | Описание |
---|---|---|
columns | UiTableColumnCustomization[] | Список столбцов для таблицы пользовательского интерфейса
Может быть |
Объект UiTableColumnCustomization
Настройка столбцов таблицы пользовательского интерфейса
Элемент | Тип | Описание |
---|---|---|
builtinColumnRef | string | Индивидуальная встроенная реализация столбца пользовательского интерфейса для этого столбца.
Может быть |
propertyRef | string | Свойство, на которое указывает ссылка, для этого столбца.
Может быть |
type | string | Конкретный тип пользовательского интерфейса для этого столбца.
Может быть |
displayName | string | Отображаемое имя для этого столбца.
Может быть |
Объект Precondition
Предварительное условие видимости свойства.
Элемент | Тип | Описание |
---|---|---|
expectedValue | object | Ожидаемая стоимость объекта.
Применимо только к свойствам Может быть |
expectedValues | object[] | Список допустимых значений свойства.
Применимо только к свойствам Может быть |
precondition | Precondition | Предварительное условие видимости свойства.
Может быть |
preconditions | Precondition[] | Список дочерних предварительных условий для оценки.
Применимо только к свойствам типов Может быть |
property | string | Объект оценки.
Может быть |
type | string | Тип предварительного условия.
Элемент может содержать эти значения |
pattern | string | Регулярное выражение, которое сопоставляется со свойством.
Применимо только к свойствам Может быть |
Объект DatasourceDefinition
Конфигурация источника данных для свойства.
Элемент | Тип | Описание |
---|---|---|
resetValue | string | Когда сбрасывать значение источника данных в пользовательском интерфейсе при изменении фильтра.
Элемент может содержать эти значения
Может быть |
свойства фильтра | string[] | Свойства для фильтрации параметров источника данных. |
подтверждать | boolean | Следует ли проверять ввод, чтобы разрешить только значения, возвращаемые источником данных. |
полныйконтекст | boolean | Ожидает ли этот источник данных полную настройку полезной нагрузки в качестве контекста. |
useApiSearch | boolean | Если это правда, источник данных должен использовать API для фильтрации результатов вместо фильтрации на стороне клиента. |
идентификатор | string | Идентификатор пользовательского источника данных значения свойства. |
Объект Item
Элемент свойства коллекции.
Элемент | Тип | Описание |
---|---|---|
referencedType | string | Тип, на который ссылается значение элемента.
Может быть |
documentation | string | Расширенное описание и/или ссылки на документацию.
Может быть |
uiCustomization | UiCustomization | Настройка элементов пользовательского интерфейса
Может быть |
datasource | DatasourceDefinition | Конфигурация источника данных для свойства.
Может быть |
subType | string | Подтип значения элемента.
Может быть |
type | object | Тип значения элемента. |
displayName | string | Отображаемое имя элемента.
Может быть |
description | string | Краткое описание предмета.
Может быть |
metadata | object | Метаданные предметов.
Может быть |
constraints | Constraint[] | Список ограничений, ограничивающих допустимые значения.
Может быть |
Объект Constraint
Ограничение на значения, принимаемые для свойства настроек.
Элемент | Тип | Описание |
---|---|---|
maxLength | integer | Максимально допустимая длина строковых значений.
Может быть |
minLength | integer | Минимальная требуемая длина строковых значений.
Может быть |
uniqueProperties | string[] | Список свойств, для которых комбинация значений должна быть уникальной.
Может быть |
customMessage | srting | Пользовательское сообщение для недопустимых значений.
Может быть |
customValidatorId | srting | Идентификатор пользовательского валидатора.
Может быть |
maximum | number | Максимально допустимое значение.
Может быть |
minimum | number | Минимально допустимое значение.
Может быть |
тип | srting | Тип ограничения.
Элемент может содержать эти значения
|
pattern | srting | Шаблон регулярного выражения для допустимых строковых значений.
Может быть |
Объект ComplexConstraint
Ограничение на значения, принимаемые для сложного свойства настроек.
Элемент | Тип | Описание |
---|---|---|
customMessage | string | Пользовательское сообщение для недопустимых значений.
Может быть |
customValidatorId | string | Идентификатор пользовательского валидатора.
Может быть |
minimumPropertyCount | integer | Минимальное количество свойств, которые необходимо установить.
Может быть |
maximumPropertyCount | integer | Максимальное количество свойств, которые можно установить.
Может быть |
properties | string[] | Список свойств (определяемых идентификаторами), которые используются для проверки ограничения.
Может быть |
type | string | Тип ограничения.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"Dynatrace": "1",
"schemaId": "builtin:container.built-in-monitoring-rule",
"displayName": "Built-in container monitoring rules",
"description": "Dynatrace 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"
}
]
}
}
}