Получение конфигурации мониторинга: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Получает конфигурацию мониторинга указанного расширения Extensions 2.0. Запрос создает <code>appl...») |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
Получает конфигурацию мониторинга указанного расширения Extensions 2.0. | Получает конфигурацию мониторинга указанного расширения Extensions 2.0. | ||
Запрос создает <code>application/json</code> | Запрос создает в качестве полезной нагрузки<code>application/json</code> формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |extensionName | ||
| | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |configurationId | ||
| | |string | ||
|Идентификатор запрошенной конфигурации мониторинга. | |Идентификатор запрошенной конфигурации мониторинга. | ||
| | |path | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 47: | Строка 44: | ||
|- | |- | ||
|200 | |200 | ||
| | |ExtensionMonitoringConfiguration | ||
|Успех | |Успех | ||
|- | |- | ||
| Строка 63: | Строка 60: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |objectId | ||
| | |string | ||
|Идентификатор конфигурации | |Идентификатор конфигурации | ||
|- | |- | ||
| | |scope | ||
| | |string | ||
|Объем конфигурации | |Объем конфигурации | ||
|- | |- | ||
| | |value | ||
| | |string | ||
|Конфигурация | |Конфигурация | ||
|} | |} | ||
Текущая версия на 16:05, 26 октября 2022
Получает конфигурацию мониторинга указанного расширения Extensions 2.0.
Запрос создает в качестве полезной нагрузкиapplication/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| configurationId | string | Идентификатор запрошенной конфигурации мониторинга. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ExtensionMonitoringConfiguration | Успех |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект _ ExtensionMonitoringConfiguration
| Элемент | Тип | Описание |
|---|---|---|
| objectId | string | Идентификатор конфигурации |
| scope | string | Объем конфигурации |
| value | string | Конфигурация |
JSON-модель тела ответа
{
"objectId": "string",
"scope": "string",
"value": "string"
}
