Получение статуса: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Получает самое последнее выполнение конфигурации мониторинга. Запрос создает <code>applicatio...») |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | ||
|- | |- | ||
|SaaS | |SaaS | ||
|<code><nowiki>https://{your-environment-id}.live. | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение конфигураций мониторинга расширений''' ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 22: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
!Необходимый | !Необходимый | ||
|- | |- | ||
| | |extensionName | ||
| | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |configurationId | ||
| | |string | ||
|Идентификатор запрошенной конфигурации мониторинга. | |Идентификатор запрошенной конфигурации мониторинга. | ||
| | |path | ||
|требуется | |требуется | ||
|} | |} | ||
| Строка 47: | Строка 47: | ||
|- | |- | ||
|200 | |200 | ||
| | |StatusDto | ||
|Успех | |Успех | ||
|- | |- | ||
| Строка 57: | Строка 57: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ExtensionStatusDto</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 63: | Строка 63: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |оtimestamp | ||
| | |integer | ||
|Временная метка последнего состояния данной конфигурации. | |Временная метка последнего состояния данной конфигурации. | ||
|- | |- | ||
| | |status | ||
| | |string | ||
|Последний статус данной конфигурации. | |Последний статус данной конфигурации. | ||
Элемент может содержать эти значения | Элемент может содержать эти значения | ||
* <code>ERROR</code> | |||
* <code>OK</code> | |||
* <code>UNKNOWN</code> | |||
|} | |} | ||
Текущая версия на 10:31, 7 октября 2022
Получает самое последнее выполнение конфигурации мониторинга.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
|
| SaaS | https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
| |
| Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимый |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| configurationId | string | Идентификатор запрошенной конфигурации мониторинга. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | StatusDto | Успех |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ExtensionStatusDto
| Элемент | Тип | Описание |
|---|---|---|
| оtimestamp | integer | Временная метка последнего состояния данной конфигурации. |
| status | string | Последний статус данной конфигурации.
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"timestamp": 1,
"status": "ERROR"
}
