API для работы с объектами
/api/Object/PutObject
Загрузить объект на сервер
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| bucketName | string | Имя бакета | query | да |
| description | string | query | нет |
Отсылаемый запрос
MIME-тип HTTP запроса: multipart/form-data
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| file | string (binary) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string (uuid) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/PutObjectUnbuffered
Загрузить объект на сервер (новая реал изация)
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| bucketName | string | Имя бакета | query | да |
| fileSize | string | Размер файла | query | да |
| description | string | query | нет |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string (uuid) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/NewMultipartUpload
Начать загрузку объекта на сервер по частям
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| fileName | string | Имя загружаемого файла | query | да |
| size | integer (int64) | Размер загружаемого файла | query | да |
| bucketName | string | Имя бакета | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | NewMultipartUploadResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/RemoveUpload
Отменить загрузку объекта на сервер по частям
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| objectId | string (uuid) | ID загружаемого файла | query | да |
| uploadId | string | ID загрузки | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/PutObjectPart
Загрузка части объекта на сервер
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| uploadId | string | Идентификатор загрузки | query | да |
| objectId | string (uuid) | Идентификатор бакета | query | да |
| size | integer (int64) | Размер загружаемого файла | query | да |
| partNumber | integer (int32) | Номер загружаемой части | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/CompleteMultipartUpload
Завершить загрузку объекта на сервер по частям
Тип HTTP запрос а: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры загрузки
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| objectId | string (uuid) | нет | ||
| uploadId | string | нет | ||
| description | string | нет | ||
| parts | UploadPart[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/ListObjects
Получить все объекты
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| bucketId | string (uuid) | query | нет | |
| start | integer (int32) | query | нет | |
| count | integer (int32) | query | нет |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| currentPage | integer (int32) | нет | ||
| pageCount | integer (int32) | нет | ||
| pageSize | integer (int32) | нет | ||
| rowCount | integer (int32) | нет | ||
| result | ObjectInfoResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/GetObjectInfoById
Получить информацию об объекте
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| objectId | string (uuid) | Идентификатор объекта | query | да |
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| На звание поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ObjectInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/RemoveObject
Удалить объект
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация об объекте (имя объекта и название бакета)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| objectName | string | Название объекта | да | |
| bucketName | string | Название бакета | да | |
| versionId | string | Версия объекта, который надо удалить. Если Null - удалить все версии | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/RemoveObjectList
Удалить список файлов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список объектов (Идентификатор объекта и идентификатор бакета)
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/GetObjectSignedUrl
Получить ссылку на скачивание объекта
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры объекта
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| objectId | string (uuid) | нет | ||
| expirationTime | integer (int32) | нет | ||
| versionId | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-ти п HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Object/ListObjectVersions
Получить список версий объекта
Тип HTTP запроса: post
Параметры
| Название | Тип | Описание | Передаётся в | Обязательное |
|---|---|---|---|---|
| objectId | string (uuid) | Идентификатор объекта | query | нет |
Отсылаемый запрос
Возвращаемые ре зультаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | FileVersion[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden