Создание архива через gRPC API для версии 4.6.0.717 Beta и ранее выпущенных версий

На странице:

Создание сущности архива

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [ {
          "uid": "hosts/server",
          "units": [ {
              "type": "MultimediaStorage",
              "properties": [
                { "id": "display_name", "properties": [], "value_string": "Archive Storage" },
                { "id": "color", "properties": [], "value_string": "Gray" },
                { "id": "storage_type", "value_string": "object" }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

где

uid − Сервер, на котором создаем архив;
units − свойства;
storage_type − тип архива: block − старый тип архива; object − новый тип архива (объектный). Если параметр явно не задан, то создается старый тип архива.

Создание тома архива

Возможные параметры ArchiveVolume в разделе properties:

Параметр	Описание
format	true − если требуется отформатировать созданный том. По умолчанию false.
volume_size_gb	Размер тома в Гб. Актуально, если 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 − cетевой архив c подключением по протоколу SMB; azure − архив в облачном хранилище Microsoft Azure. s3 − архив в облачном хранилище Amazon S3 (aws.amazon.com/s3), Wasabi (wasabi.com), Huawei Cloud (huaweicloud.com) или Seagate Lyve Cloud (seagate.com).
Параметры для типа file:
path	Да	Путь к файлу/диску с архивом.
Параметры для типа smb:
host	Да	Имя сервера с сетевым хранилищем.
smb_share	Да	Сетевое хранилище.
path	Да	Папка в сетевом хранилище, в которой будет храниться архив.
smb_domain	Нет	Домен сетевого хранилища.
user	Нет	Имя пользователя.
password	Нет	Пароль.
Параметры для типа Аzure:
protocol	Да	Протокол подключения: HTTP или HTTPS. Этот параметр находится в свойствах созданного контейнера.
host	Да	Адрес сервера Azure. Этот параметр находится в свойствах созданного контейнера.
access_key	Да	Ключ доступа в base64. Этот параметр находится в разделе Ключи доступа.
container	Да	Контейнер Azure. Данный параметр находится в свойствах созданного контейнера.
user	Да	Имя пользователя. Этот параметр находится в разделе Ключи доступа (Storage account name).
path	Нет	Расположение папки тома в Azure.
port	Нет	Порт сервера Azure.
Параметры для типа s3 (хранилище Amazon):
access_key_id	Да	Идентификатор ключа доступа (создание ключей доступа на странице https://console.aws.amazon.com/iam/home?#/security_credentials$access_key, требуется авторизация).
secret_access_key	Да	Пароль ключа доступа (доступен после создания ключа доступа).
bucket	Да	Том архива в аккаунте Amazon S3 (bucket). Разные тома могут находиться в разных регионах. На сервере Amazon S3 имя тома должно быть уникальным и для работы в Axxon Next должно быть предварительно создано самим пользователем по правилам (см. https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
region	Да	Регион нахождения тома. Для уменьшения задержек при записи и чтении архива необходимо указывать ближайший регион до Сервера Axxon Next. Список возможных регионов − https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints.
path	Да	Расположение папки тома Axxon Next внутри bucket.
protocol	Да	Протокол подключения: HTTP или HTTPS.
host	Да	Адрес сервера Amazon S3 в формате <bucket_name>.s3.amazonaws.com.
Параметры для типа s3 (хранилище 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	Да	Адрес сервера Wasabi в формате s3.<region>.wasabisys.com.
Параметры для типа s3 (хранилище 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	Да	Адрес сервера. Соответствует параметру Endpoint в свойствах Bucket.
Параметры для типа s3 (хранилище 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	Да	Адрес сервера. Соответствует параметру Virtual Host URL в свойствах Bucket.

Пример создания объектного архива в виде файлов на локальном диске:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "file" },
                            { "id": "path", "value_string": "D:/Dev/!temp/Archive" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true },
                { "id": "auto_mount", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива на сетевом ресурсе:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "smb" },
                            { "id": "host", "value_string": "qa-t9" },
                            { "id": "smb_share", "value_string": "incoming" },
                            { "id": "path", "value_string": "video" },
                            { "id": "user", "value_string": "Tester" },
                            { "id": "password", "value_string": "123456" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true },
                { "id": "auto_mount", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива в Microsoft Azure:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "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 archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива в Amazon S3:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "bucketname" },
                            { "id": "region", "value_string": "eu-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": "https" },
                            { "id": "host", "value_string": "bucketname.s3.amazonaws.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива в Wasabi:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Tan",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "archive-wasabi" },
                            { "id": "region", "value_string": "eu-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": "https" },
                            { "id": "host", "value_string": "s3.eu-central-1.wasabisys.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива в Huawei Cloud:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "axxon-test" },
                            { "id": "region", "value_string": "na-mexico-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": "obs.na-mexico-1.myhuaweicloud.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Пример создания объектного архива в Seagate Lyve Cloud:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Tan",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "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": "s3.us-west-1.lyvecloud.seagate.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Изменение тома архива

Для изменения тома архива используются те же параметры, что и при его создании.

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray/ArchiveVolume.495c3ef4-043f-4890-a4e0-c66f4fa252e7",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                  "id": "connection_params",
                  "value_properties": {
                     "properties": [
                       { "id": "schema", "value_string": "file" },
                       { "id": "path", "value_string": "D:/AliceBlueBlock" } 
                  ] }
                },
                { "id": "label", "value_string": "Test archive block" },
                { "id": "volume_size_gb", "value_uint64": 100 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Page tree

Документация для версии Axxon Next 4.6.0. Документация на другие версии также доступна.

Создание сущности архива

Создание тома архива

Изменение тома архива