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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. Запрос потр...»)
 
Строка 3: Строка 3:
Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЧТА
| rowspan="3" |POST
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code>
|<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>
|<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><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code>
|}
|}


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигураций мониторинга расширений ( <code>extensionConfigurations.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Запись конфигураций мониторинга расширений''' ( <code>extensionConfigurations.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 22: Строка 22:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|имя_расширения
|extensionName
|нить
|string
|Имя запрошенного расширения 2.0.
|Имя запрошенного расширения 2.0.
|дорожка
|path
|требуется
|требуется
|-
|-
|тело
|body
|Конфигурация мониторинга Dto []
|MonitoringConfigurationDto[]
|Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга.
|Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга.
|тело
|body
|требуется
|требуется
|}
|}
Строка 48: Строка 48:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|сфера
|scope
|нить
|string
|Область, для которой будет определена эта конфигурация мониторинга
|Область, для которой будет определена эта конфигурация мониторинга
|требуется
|требуется
|-
|-
|ценность
|value
|Json- узел
|JsonNode
|Конфигурация мониторинга
|Конфигурация мониторинга
|по желанию
|по желанию
Строка 84: Строка 84:
|-
|-
|200
|200
|Отслеживание ответа конфигурации []
|MonitoringConfigurationResponse[]
|Успех
|Успех
|-
|-
|207
|207
|Ответ Конфигурации Мониторинга
|MonitoringConfigurationResponse
|Мультистатус, если не все запросы привели к одному и тому же статусу
|Мультистатус, если не все запросы привели к одному и тому же статусу
|-
|-
Строка 107: Строка 107:
!Описание
!Описание
|-
|-
|идентификатор объекта
|objectId
|нить
|string
|Идентификатор новой конфигурации
|Идентификатор новой конфигурации
|-
|-
|код
|code
|целое число
|integer
|Код состояния HTTP
|Код состояния HTTP
|}
|}

Версия 06:09, 5 октября 2022

Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0.

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

POST 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.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
extensionName string Имя запрошенного расширения 2.0. path требуется
body MonitoringConfigurationDto[] Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. body требуется

Объекты тела запроса

Объект _ RequestBody

Объект не предоставляет никаких параметров.

Объект _ MonitoringConfigurationDto

Элемент Тип Описание Необходимость
scope string Область, для которой будет определена эта конфигурация мониторинга требуется
value JsonNode Конфигурация мониторинга по желанию

Объект _ JsonNode

Конфигурация мониторинга

Объект не предоставляет никаких параметров.

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

[
  {
    "scope": "HOST-D3A3C5A146830A79",
    "value": {}
  }
]

Ответ

Коды ответов

Код Тип Описание
200 MonitoringConfigurationResponse[] Успех
207 MonitoringConfigurationResponse Мультистатус, если не все запросы привели к одному и тому же статусу
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект _ ResponseBody

Объект не предоставляет никаких параметров.

Объект _ MonitoringConfigurationResponse

Элемент Тип Описание
objectId string Идентификатор новой конфигурации
code integer Код состояния HTTP

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

[
  {
    "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "code": 1
  }
]
Источник — https://doc.ruscomtech.ru/index.php?title=Размещение_конфигурации_мониторинга&oldid=1506