Перейти в хранилище документации
Обратиться в техническую поддержку
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/server", "units": [ { "type": "MultimediaStorage", "properties": [ { "id": "display_name", "properties": [], "value_string": "ArchiveStorage" }, { "id": "color", "properties": [], "value_string": "Gray" }, { "id": "storage_type", "value_string": "object" } ] } ] } ] } }
где
Возможные параметры ArchiveVolume в разделе properties:
Параметр | Описание |
---|---|
format | true − если требуется отформатировать созданный том. По умолчанию false. |
volume_size | Размер тома в байтах. Актуально, если format = true. |
auto_mount | true − если нужно монтировать созданный том. По умолчанию true. |
label | Метка тома. |
Параметры только для объектного архива (storage_type = object): | |
max_block_size_mb | Максимальный размер блоков в Мб. Значение по умолчанию 64, диапазон допустимых значений [16; 512]. |
optimal_read_size_mb | Оптимальный размер чтения блоков в Мб. Значение по умолчанию 4, диапазон допустимых значений [1; max_block_size_mb / 2]. |
incoming_buffer_size_mb | Приходящий размер буфера в Мб. Значение по умолчанию 3 * max_block_size_mb. Минимальное значение должно быть больше 2 * max_block_size_mb. |
block_flush_period_seconds | Период записи блоков в секундах. Значение по умолчанию 60, диапазон допустимых значений [30; 300]. |
index_snapshot_max_block_distance | Максимальное количество блоков между операциями индексации. Значение по умолчанию 256, минимальное значение 16. |
sequence_flush_period_seconds | Периодичность записи последовательностей в секундах. Значение по умолчанию 60, минимальное значение 32. |
На уровне ArchiveVolume также должно добавляться свойство connection_params со следующими параметрами:
Параметр | Обязательный | Описание |
---|---|---|
schema | Да | Тип тома. Возможные значения: file − локальный архив на Сервере. smb − удаленный архив с подключением по протоколу SMB. azure − архив в облачном хранилище Microsoft Azure. s3_amazon − архив в облачном хранилище Amazon S3 (aws.amazon.com/s3). s3_huawei − архив в облачном хранилище Huawei Cloud (huaweicloud.com). s3_seagate − архив в облачном хранилище Seagate Lyve Cloud (seagate.com). s3_wasabi − архив в облачном хранилище Wasabi (wasabi.com). s3_minio − универсальный архив в облачном хранилище (min.io.com). Применяется при использовании других видов облачных хранилищ. |
Параметры для типа file: | ||
path | Да | Путь к файлу/диску с архивом. |
Параметры для типа smb: | ||
host | Да | Имя Сервера с удаленнным хранилищем. |
smb_share | Да | Удаленное хранилище. |
path | Да | Папка в удаленном хранилище, в которой будет храниться архив. |
smb_domain | Нет | Домен удаленного хранилища. |
user | Нет | Имя пользователя. |
password | Нет | Пароль. |
Параметры для типа azure: | ||
protocol | Да | Протокол подключения: HTTP или HTTPS. Этот параметр находится в свойствах созданного контейнера. |
host | Да | Адрес Сервера Azure. Этот параметр находится в свойствах созданного контейнера. |
access_key | Да | Ключ доступа в base64. Этот параметр находится в разделе Ключи доступа. |
container | Да | Контейнер Azure. Данный параметр находится в свойствах созданного контейнера. |
user | Да | Имя пользователя. Этот параметр находится в разделе Ключи доступа (Storage account name). |
path | Нет | Для Azure указывать расположение папки тома не нужно − параметр должен остаться пустым. |
port | Нет | Порт Сервера Azure. |
Параметры для типа s3_amazon (хранилище Amazon): | ||
access_key_id | Да | Идентификатор ключа доступа (создание ключей доступа на странице https://console.aws.amazon.com/iam/home?#/security_credentials$access_key, требуется авторизация). |
secret_access_key | Да | Пароль ключа доступа (доступен после создания ключа доступа). |
bucket | Да | Том архива в аккаунте Amazon S3 (bucket). Разные тома могут находиться в разных регионах. На Сервере Amazon S3 имя тома должно быть уникальным и для работы в Интеллект X должно быть предварительно создано самим пользователем по правилам (см. https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). |
region | Да | Регион нахождения тома. Для уменьшения задержек при записи и чтении архива необходимо указывать ближайший регион до Сервера Интеллект X. Список возможных регионов – https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints. |
path | Да | Расположение папки тома Интеллект X внутри bucket. |
protocol | Да | Протокол подключения: HTTP или HTTPS. |
host | Да | Адрес Сервера: amazonaws.com. |
Параметры для типа s3_wasabi (хранилище Wasabi): | ||
bucket | Да | Имя тома архива (Bucket Name), предварительно заданное пользователем в https://console.wasabisys.com/#/file_manager. |
region | Да | Регион нахождения соответствующего тома, заданный в https://console.wasabisys.com/#/file_manager. |
access_key_id | Да | Идентификатор ключа доступа, который необходимо создать предварительно на странице https://console.wasabisys.com/#/access_keys. |
secret_access_key | Да | Пароль ключа доступа (доступен после создания ключа доступа). |
protocol | Да | Протокол подключения: HTTP или HTTPS. |
path | Да | Расположение папки, созданной внутри тома (объект Folder в Bucket). |
host | Да | Адрес Сервера: wasabisys.com. |
Параметры для типа s3_huawei (хранилище Huawei Cloud): | ||
bucket | Да | Имя тома архива (Bucket Name), предварительно заданное пользователем на вкладке Object Storage Service. |
region | Да | Регион нахождения соответствующего тома, заданный при его создании. Указан в параметре Endpoint в свойствах Bucket. |
access_key_id | Да | Идентификатор ключа доступа, который необходимо создать, перейдя по ссылке «Obtain access keys (AK and SK)». |
secret_access_key | Да | Пароль ключа доступа (доступен после создания ключа доступа). |
path | Да | Расположение папки, созданной внутри тома. |
protocol | Да | Протокол подключения: HTTP или HTTPS. |
host | Да | Адрес Сервера: myhuaweicloud.com. |
Параметры для типа s3_seagate (хранилище Seagate Lyve Cloud): | ||
bucket | Да | Имя тома архива (Bucket Name), предварительно заданное пользователем. Соответствует параметру Name в свойствах Bucket. |
region | Да | Регион нахождения соответствующего тома, заданный при его создании. Соответствует параметру Region в свойствах Bucket. |
access_key_id | Да | Идентификатор ключа доступа, который генерируется при создании учётной записи в окне Create Service Account. |
secret_access_key | Да | Пароль ключа доступа (доступен после генерации ключа доступа). |
path | Да | Расположение папки, созданной внутри тома. |
protocol | Да | Протокол подключения: HTTP или HTTPS. |
host | Да | Адрес Сервера: lyvecloud.seagate.com. |
Параметры для типа s3_minio (хранилище MinIO): | ||
bucket | Да | Имя тома архива (Bucket Name), предварительно заданное пользователем. Соответствует параметру Name в свойствах Bucket. |
bucket_endpoint | Нет | Имя домена с портом. Внимание! Параметр необходимо использовать только при использовании MinIO, если указывается доменное имя Сервера MinIO, вместо IP-Адреса Сервера. Пример: http://miniopoc1.agis.xh.ar:9000
|
region | Да | Регион нахождения тома. |
access_key_id | Да | Идентификатор ключа доступа. |
secret_access_key | Да | Пароль ключа доступа (доступен после создания ключа доступа). |
path | Нет | Расположение папки тома Интеллект X внутри bucket. |
protocol | Да | Протокол подключения: HTTP или HTTPS. |
host | Да | Адрес Сервера. |
port | Да | Порт Сервера. |
Примечание
Существует возможность создать несколько томов облачного архива.
Внимание!
Пример создания тома архива в виде файлов на локальном диске:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ {"id": "schema","value_string": "file"}, {"id": "path","value_string": "D:/archives"} ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "26843545600"}, {"id": "format","value_bool": true}, { "id": "auto_mount", "value_bool": true } ]}]} ] } }
Пример создания тома архива на удаленном ресурсе:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "smb" }, { "id": "host", "value_string": "computer" }, { "id": "smb_domain", "value_string": "domain" }, { "id": "smb_share", "value_string": "Share" }, { "id": "path", "value_string": "video" }, { "id": "user", "value_string": "Tester" }, { "id": "password", "value_string": "Testing321" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "12073741824"}, {"id": "format","value_bool": true} ]} ] } ] } }
Пример создания тома облачного архива в Microsoft Azure:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "azure" }, { "id": "protocol", "value_string": "https" }, { "id": "host", "value_string": "axxonsoft.blob.core.windows.net" }, { "id": "access_key", "value_string": "youraccesskey==" }, { "id": "container", "value_string": "container" }, { "id": "user", "value_string": "axxonsoft" }, { "id": "path", "value_string": "" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "12073741824"}, {"id": "format","value_bool": true} ]} ] } ] } }
Пример создания тома облачного архива в Amazon:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3_amazon" }, { "id": "bucket", "value_string": "axxonsoft-test" }, { "id": "region", "value_string": "us-west-1" }, { "id": "access_key_id", "value_string": "youraccesskeyid" }, { "id": "secret_access_key", "value_string": "yoursecretaccesskey" }, { "id": "path", "value_string": "path" }, { "id": "protocol", "value_string": "https" }, { "id": "host", "value_string": "amazonaws.com" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "12073741824"}, {"id": "format","value_bool": true} ]} ] } ] } }
Пример создания тома облачного архива в Wasabi:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3_wasabi" }, { "id": "bucket", "value_string": "axxontest-1" }, { "id": "region", "value_string": "us-central-1" }, { "id": "access_key_id", "value_string": "youraccesskeyid" }, { "id": "secret_access_key", "value_string": "yoursecretaccesskey" }, { "id": "path", "value_string": "path" }, { "id": "protocol", "value_string": "http" }, { "id": "host", "value_string": "wasabisys.com" } ]}} ]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "209715200"}, {"id": "format","value_bool": true} ] } ] } ] } }
Пример создания тома облачного архива в Huawei Cloud:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3_huawei" }, { "id": "bucket", "value_string": "axxon-test-1" }, { "id": "region", "value_string": "ap-southeast-1" }, { "id": "access_key_id", "value_string": "youraccesskeyid" }, { "id": "secret_access_key", "value_string": "yoursecretaccesskey" }, { "id": "path", "value_string": "path" }, { "id": "protocol", "value_string": "https" }, { "id": "host", "value_string": "myhuaweicloud.com" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "10073741824"}, {"id": "format","value_bool": true} ] } ] } ] } }
Пример создания тома облачного архива в Seagate Lyve Cloud:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/SERVER/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3_seagate" }, { "id": "bucket", "value_string": "axxonsoft-test" }, { "id": "region", "value_string": "us-west-1" }, { "id": "access_key_id", "value_string": "youraccesskeyid" }, { "id": "secret_access_key", "value_string": "yoursecretaccesskey" }, { "id": "path", "value_string": "path" }, { "id": "protocol", "value_string": "https" }, { "id": "host", "value_string": "lyvecloud.seagate.com" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": "1073741824"}, {"id": "format","value_bool": true} ]}]} ] } }
Пример создания тома облачного архива в MinIO S3:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/ServerName/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3" }, { "id": "bucket", "value_string": "bucket" }, { "id": "region", "value_string": "us-east-1" }, { "id": "access_key_id", "value_string": "MINIOROOT" }, { "id": "secret_access_key", "value_string": "MINIOPASS" }, { "id": "path", "value_string": "path" }, { "id": "protocol", "value_string": "http" }, { "id": "host", "value_string": "192.168.56.102" }, { "id": "port", "value_string": "9000" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": 1207374182}, {"id": "format","value_bool": true} ]} ] } ] } }
Пример создания тома облачного архива в MinIO S3 с использованием имени домена:
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "added": [ { "uid": "hosts/Server/MultimediaStorage.Gray", "units": [ { "type": "ArchiveVolume", "properties": [ { "id": "volume_type", "value_string": "object", "properties": [ { "id": "connection_params", "value_properties": { "properties": [ { "id": "schema", "value_string": "s3" }, { "id": "bucket", "value_string": "bucket" }, { "id": "region", "value_string": "us-east-1" }, { "id": "access_key_id", "value_string": "MINIOROOT" }, { "id": "secret_access_key", "value_string": "MINIOPASS" }, { "id": "path", "value_string": "" }, { "id": "protocol", "value_string": "http" }, { "id": "host", "value_string": "" }, { "id": "bucket_endpoint", "value_string": "http://miniopoc1.agis.xh.ar:9000" } ]}}]}, {"id": "label","value_string": "test"}, {"id": "volume_size","value_uint64": 1207374182}, {"id": "format","value_bool": true} ]} ] } ] } }
Для изменения тома архива используются те же параметры, что и при его создании.
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": { "changed": [ { "uid": "hosts/Server/MultimediaStorage.Gray/ArchiveVolume.4508f459-5eeb-4ee3-881b-4a4e149c7802", "properties": [ { "id": "label", "value_string": "NewLabel" }, { "id": "readonly", "value_bool": false }, { "id": "connection_params", "value_properties": { "properties": [ { } ] } } ] } ] } }