Работа с сервисами.
/services/configurationservice/api/service/delete
Удаление информации о сервисе.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения метода
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/configurationservice/api/service/edit
Редактирование парам етров сервиса.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя сервиса | нет | |
| description | string | Полное описание сервиса | нет | |
| title | string | Краткое описание сервиса | нет | |
| type | ServiceTypes | |||
| syncToNginx | boolean | Признак необходимости синхронизациис nginx | нет | |
| useNginxWorkStatus | boolean | нет | ||
| isSystem | boolean | Признак системного сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения метода
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/configurationservice/api/service/add
Регистрация нового сервиса.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя сервиса | нет | |
| description | string | Полное описание сервиса | нет | |
| title | string | Краткое описание сервиса | нет | |
| type | ServiceTypes | |||
| syncToNginx | boolean | Признак того, что ноды сервиса должны синхронизироваться с nginx | нет | |
| useNginxWorkStatus | boolean | нет | ||
| isSystem | boolean | Признак системного сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат с идентификатором сервиса или ошибкой.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |