Перейти к основному содержимому

Операциями с местами физического хранения

/api/v2/Storage/List

Получить список мест хранения

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

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

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultStorageListResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/filesservice public StorageController List()

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

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

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

URL-адрес OpenId Connect:

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

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

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

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

URL-адрес OpenId Connect:

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

/api/v2/Storage/Create

Создать место хранения файлов

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
namestringИмянет
descriptionstringОписаниенет
mountingPointstringпуть в логической файловой системенет
pathstringНазвание хранилища(бакета) в S3нет
typestringСейчас всегда S3нет
connectionParamsLinkstringПараметры подключения к хранилищу S3. В виде ссылки на переменные окружения.
Нужны для поддержки нескольких S3 хранилищ.
нет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/filesservice public StorageController Create(ASE.MD.Platform.Services.FilesService.Models.Params.CreateStorageLocationParams)

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

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

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

URL-адрес OpenId Connect:

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

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

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

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

URL-адрес OpenId Connect:

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

/api/v2/Storage/Remove

Удалить место хранения файлов. Для удаления в нем не должно быть файлов.

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
storageLocationIdstring (uuid)ID места хранениянет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/filesservice public StorageController Remove(ASE.MD.Platform.Services.FilesService.Models.Params.RemoveStorageLocationParams)

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

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

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

URL-адрес OpenId Connect:

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

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

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

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

URL-адрес OpenId Connect:

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

/api/v2/Storage/GetInfo

Получить информацию о месте хранения файлов

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
storageLocationIdstring (uuid)ID места хранениянет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultStorageLocationInfo
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/filesservice public StorageController GetInfo(ASE.MD.Platform.Services.FilesService.Models.Params.StorageLocationParams)

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

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

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

URL-адрес OpenId Connect:

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

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

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

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

URL-адрес OpenId Connect:

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