Работа с сервисами.

/api/service/delete

Удаление информации о сервисе.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры запроса (Идентификатор сервиса.)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения метода

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Пользовательское сообщение об ошибке.	нет
code	string	Код ошибки.	да
isError	boolean	Признак наличия ошибки.	да
stackTrace	string	Трейс стека вызовов.	нет
innerErrors	IErrorDescription[]	Вложенные исключения.	нет
techMessage	string	Техническое сообщение об ошибке.	нет
dateTime	string (date-time)	Дата и время возникновения ошибки (с часовым поясом).	нет
exceptionType	string	Тип исключения.	нет
source	string	Имя источника.	нет
inners	InnerInfo[]	Элементы исключений.	нет
extra	string	Трейс стека.	нет
id	string	Идентификатор ошибки.	нет
type	ErrorTypes
data	object	Дополнительные данные.	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ServiceController DeleteService(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ServiceIdentifier)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/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	Пользовательское сообщение об ошибке.	нет
code	string	Код ошибки.	да
isError	boolean	Признак наличия ошибки.	да
stackTrace	string	Трейс стека вызовов.	нет
innerErrors	IErrorDescription[]	Вложенные исключения.	нет
techMessage	string	Техническое сообщение об ошибке.	нет
dateTime	string (date-time)	Дата и время возникновения ошибки (с часовым поясом).	нет
exceptionType	string	Тип исключения.	нет
source	string	Имя источника.	нет
inners	InnerInfo[]	Элементы исключений.	нет
extra	string	Трейс стека.	нет
id	string	Идентификатор ошибки.	нет
type	ErrorTypes
data	object	Дополнительные данные.	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ServiceController EditService(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ServiceChangeParameter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/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.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ServiceController ServiceInstall(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ServiceNewParameter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write