Получение всех конфигураций мониторинга: различия между версиями

Версия от 20:18, 4 октября 2022

Список всех конфигураций мониторинга указанного расширения Extensions 2.0.

Запрос создает application/jsonполезную нагрузку.

GET	Managed	`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`
	Окружающая среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	В	Необходимый
nextPageKey	string	Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.	запрос	по желанию
pageSize	integer	Количество расширений в полезной нагрузке одного ответа. Максимально допустимый размер страницы — 100. Если не установлено, используется 20.	запрос	по желанию
extensionName	string	Имя запрошенного расширения 2.0.	дорожка	требуется
version	string	Фильтрует результирующий набор конфигураций по версии расширения 2.0.	запрос	по желанию
active	boolean	Фильтрует результирующий набор конфигураций по активному состоянию.	запрос	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	ExtensionMonitoringConfigurationsList	Успех
400	ErrorEnvelope	Не удалось. Ввод недействителен.
404	ErrorEnvelope	Не удалось. Запрошенный ресурс не существует.

Объекты тела ответа

Объект _ `ExtensionMonitoringConfigurationsList`

Элемент	Тип	Описание
items	ExtensionMonitoringConfiguration[]	Список конфигураций мониторинга расширений.
totalCount	integer	Общее количество записей в результате.
pageSize	integer	Количество записей на странице.
nextPageKey	string	Курсор для следующей страницы результатов. Имеет значение `null`на последней странице. Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Объект _ `ExtensionMonitoringConfiguration`

Элемент	Тип	Описание
objectId	string	Идентификатор конфигурации
scope	string	Объем конфигурации
value	string	Конфигурация

JSON-модель тела ответа

{
  "items": [
    {
      "objectId": "string",
      "scope": "string",
      "value": "string"
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ=="
}

@@ Строка 3: / Строка 3: @@
 Запрос создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="3" |GET
-|Удалось
+|Managed
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code>
 |-
@@ Строка 10: / Строка 10: @@
 |<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code>
 |-
-|Окружающая среда ActiveGate
+|Окружающая среда АктивногоШлюза
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code>
 |}
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 25: / Строка 25: @@
 !Необходимый
 |-
-|ключ следующей страницы
+|nextPageKey
-|нить
+|string
 |Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
@@ Строка 35: / Строка 35: @@
 |по желанию
 |-
-|размер страницы
+|pageSize
-|целое число
+|integer
 |Количество расширений в полезной нагрузке одного ответа.
@@ Строка 45: / Строка 45: @@
 |по желанию
 |-
-|имя_расширения
+|extensionName
-|нить
+|string
 |Имя запрошенного расширения 2.0.
 |дорожка
 |требуется
 |-
-|версия
+|version
-|нить
+|string
 |Фильтрует результирующий набор конфигураций по версии расширения 2.0.
 |запрос
 |по желанию
 |-
-|активный
+|active
-|логический
+|boolean
 |Фильтрует результирующий набор конфигураций по активному состоянию.
 |запрос
@@ Строка 73: / Строка 73: @@
 |-
 |200
-|Список конфигураций мониторинга расширений
+|ExtensionMonitoringConfigurationsList
 |Успех
 |-
@@ Строка 93: / Строка 93: @@
 !Описание
 |-
-|Предметы
+|items
-|Конфигурация мониторинга расширений []
+|ExtensionMonitoringConfiguration[]
 |Список конфигураций мониторинга расширений.
 |-
-|общее количество
+|totalCount
-|целое число
+|integer
 |Общее количество записей в результате.
 |-
-|размер страницы
+|pageSize
-|целое число
+|integer
 |Количество записей на странице.
 |-
-|ключ следующей страницы
+|nextPageKey
-|нить
+|string
 |Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
@@ Строка 118: / Строка 118: @@
 !Описание
 |-
-|идентификатор объекта
+|objectId
-|нить
+|string
 |Идентификатор конфигурации
 |-
-|сфера
+|scope
-|нить
+|string
 |Объем конфигурации
 |-
-|ценность
+|value
-|нить
+|string
 |Конфигурация
 |}