Размещение конфигурации мониторинга: различия между версиями
Материал из Dynatrace
ENetrebin (обсуждение | вклад) (Новая страница: «Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. Запрос потр...») |
ENetrebin (обсуждение | вклад) |
||
(не показаны 3 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. | Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. | ||
Запрос | Запрос создает и использует в качестве полезной нагрузки <code>application/json</code> формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |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> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<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: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |extensionName | ||
| | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |body | ||
| | |MonitoringConfigurationDto[] | ||
|Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | |Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | ||
| | |body | ||
|требуется | |требуется | ||
|} | |} | ||
Строка 40: | Строка 37: | ||
=== Объекты тела запроса === | === Объекты тела запроса === | ||
==== Объект | ==== Объект <code>RequestBody</code> ==== | ||
Объект не предоставляет никаких параметров. | Объект не предоставляет никаких параметров. | ||
==== Объект | ==== Объект <code>MonitoringConfigurationDto</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |scope | ||
| | |string | ||
|Область, для которой будет определена эта конфигурация мониторинга | |Область, для которой будет определена эта конфигурация мониторинга | ||
|требуется | |требуется | ||
|- | |- | ||
| | |value | ||
| | |JsonNode | ||
|Конфигурация мониторинга | |Конфигурация мониторинга | ||
|по желанию | |по желанию | ||
|} | |} | ||
==== Объект | ==== Объект <code>JsonNode</code> ==== | ||
Конфигурация мониторинга | Конфигурация мониторинга | ||
Строка 84: | Строка 81: | ||
|- | |- | ||
|200 | |200 | ||
| | |MonitoringConfigurationResponse[] | ||
|Успех | |Успех | ||
|- | |- | ||
|207 | |207 | ||
| | |MonitoringConfigurationResponse | ||
|Мультистатус, если не все запросы привели к одному и тому же статусу | |Мультистатус, если не все запросы привели к одному и тому же статусу | ||
|- | |- | ||
Строка 98: | Строка 95: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ResponseBody</code> ==== | ||
Объект не предоставляет никаких параметров. | Объект не предоставляет никаких параметров. | ||
==== Объект | ==== Объект <code>MonitoringConfigurationResponse</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 107: | Строка 104: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |objectId | ||
| | |string | ||
|Идентификатор новой конфигурации | |Идентификатор новой конфигурации | ||
|- | |- | ||
| | |code | ||
| | |integer | ||
|Код состояния HTTP | |Код состояния HTTP | ||
|} | |} |
Текущая версия на 10:55, 27 октября 2022
Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0.
Запрос создает и использует в качестве полезной нагрузки application/json
формат.
POST | Managed | https://{your-domain}/e/{your-environment-id}/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
}
]