Получение всех конфигураций мониторинга
Материал из Документация Ключ-АСТРОМ
Версия от 15:22, 4 октября 2022; ENetrebin (обсуждение | вклад)
Список всех конфигураций мониторинга указанного расширения Extensions 2.0.
Запрос создает application/jsonполезную нагрузку.
| ПОЛУЧИТЬ | Удалось | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations
|
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations
| |
| Окружающая среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимый |
|---|---|---|---|---|
| ключ следующей страницы | нить | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | по желанию |
| размер страницы | целое число | Количество расширений в полезной нагрузке одного ответа.
Максимально допустимый размер страницы — 100. Если не установлено, используется 20. |
запрос | по желанию |
| имя_расширения | нить | Имя запрошенного расширения 2.0. | дорожка | требуется |
| версия | нить | Фильтрует результирующий набор конфигураций по версии расширения 2.0. | запрос | по желанию |
| активный | логический | Фильтрует результирующий набор конфигураций по активному состоянию. | запрос | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Список конфигураций мониторинга расширений | Успех |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект _ ExtensionMonitoringConfigurationsList
| Элемент | Тип | Описание |
|---|---|---|
| Предметы | Конфигурация мониторинга расширений [] | Список конфигураций мониторинга расширений. |
| общее количество | целое число | Общее количество записей в результате. |
| размер страницы | целое число | Количество записей на странице. |
| ключ следующей страницы | нить | Курсор для следующей страницы результатов. Имеет значение nullна последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
Объект _ ExtensionMonitoringConfiguration
| Элемент | Тип | Описание |
|---|---|---|
| идентификатор объекта | нить | Идентификатор конфигурации |
| сфера | нить | Объем конфигурации |
| ценность | нить | Конфигурация |
JSON-модель тела ответа
{
"items": [
{
"objectId": "string",
"scope": "string",
"value": "string"
}
],
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ=="
}