Create archive using gRPC API methods for version 1.9 Beta and later versions

On this page:

Creating a storage

{
    "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" }
      ] } ] } ]
 
    }
}

where

uid − Server on which the archive is created;
units − properties;
volume_type − archive type: block − old archive type; object − new archive type (object archive). If the parameter is not explicitly specified, then an archive of old type is created.

Creating an archive volume

Possible ArchiveVolume parameters in the properties section:

Parameter	Description
format	true if it is necessary to format the created volume. The default is false.
volume_size	Volume size in bytes. Applicable if format = true.
auto_mount	true if it is necessary to mount the created volume. The default is false.
label	Volume label
Parameters for object archives only (storage_type = object):
max_block_size_mb	Maximum block size in MB. The default is 64, the range of valid values is [16; 512].
optimal_read_size_mb	Optimal size of blocks reading in MB. The default is 4, the range of valid values is [1; max_block_size_mb / 2].
incoming_buffer_size_mb	The incoming buffer size in MB. The default is 3 * max_block_size_mb. The minimum value should be greater than 2 * max_block_size_mb.
block_flush_period_seconds	Block recording period in seconds. The default is 60, the range of valid values is [30; 300].
index_snapshot_max_block_distance	The maximum number of blocks between indexing operations. The default is 256, the minimum is 16.
sequence_flush_period_seconds	Sequences recording period in seconds. The default is 60, the minimum is 32.

At the ArchiveVolume level, the connection_params property is also added, with the following parameters:

Parameter	Required	Description
schema	Yes	Volume type. Possible values: file − local archive on the Server; smb − network archive with an SMB protocol connection; azure − archive in Microsoft Azure cloud storage; s3_amazon − archive in Amazon S3 cloud storage (aws.amazon.com/s3). s3_wasabi − archive in Wasabi cloud storage (wasabi.com). s3_huawei − archive in Huawei Cloud cloud storage (huaweicloud.com). s3_seagate − archive in Seagate Lyve Cloud cloud storage (seagate.com).
Parameters for the file type:
path	Yes	The path to the file/disk with the archive.
Parameters for the smb type:
host	Yes	Name of the server with network repository.
smb_share	Yes	Network repository.
path	Yes	Folder in network repository, where the archive will be stored.
smb_domain	No	Network repository domain.
user	No	User name.
password	No	Password.
Parameters for the azure type:
protocol	Yes	Connection protocol: HTTP or HTTPS. This parameter is located in the properties of the created container.
host	Yes	Azure server address. This parameter is located in the properties of the created container.
access_key	Yes	Access key in base64. This parameter is located in the Access keys section.
container	Yes	Azure container. This parameter is located in the properties of the created container.
user	Yes	User name. This parameter is located in the Access keys section (Storage account name).
path	No	Do not specify the location of the volume folder in Azure — the parameter should be empty.
port	No	Azure server port.
Parameters for the s3_amazon type (Amazon storage):
access_key_id	Yes	Access key identifier (create access keys at https://console.aws.amazon.com/iam/home?#/security_credentials$access_key, authorization required).
secret_access_key	Yes	Access key password (available after creating an access key).
bucket	Yes	Archive volume in Amazon S3 account (bucket). Different volumes can be located in different regions. On the Amazon S3 server, the volume name should be unique, and for the Axxon One operation, it should be pre-created by the user according to the rules (see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
region	Yes	The region where the volume is located. To reduce the delay when writing and reading an archive, specify the closest region to the Axxon One Server. For the list of possible regions, see https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints.
path	Yes	Location of the Axxon One volume folder inside the bucket.
protocol	Yes	Connection protocol: HTTP or HTTPS.
host	Yes	Server address: amazonaws.com.
Parameters for the s3_wasabi type (Wasabi storage):
bucket	Yes	Archive volume name (Bucket Name), predefined by the user at https://console.wasabisys.com/#/file_manager.
region	Yes	The region where the corresponding volume is located, as specified at https://console.wasabisys.com/#/file_manager.
access_key_id	Yes	Access key identifier, which should be pre-created at https://console.wasabisys.com/#/access_keys.
secret_access_key	Yes	Access key password (available after creating an access key).
protocol	Yes	Connection protocol: HTTP or HTTPS.
path	Yes	Location of the folder created inside the bucket (Folder object in Bucket).
host	Yes	Server address: wasabisys.com.
Parameters for the s3_huawei type (Huawei Cloud storage):
bucket	Yes	Archive volume name (Bucket Name), predefined by the user at the Object Storage Service tab.
region	Yes	The region where the corresponding volume is located, as specified when it was created. Specified in the Endpoint parameter in the Bucket properties.
access_key_id	Yes	Access key identifier, which should be created by clicking on the link "Obtain access keys (AK and SK)".
secret_access_key	Yes	Access key password (available after creating an access key).
path	Yes	Location of the folder created inside the bucket.
protocol	Yes	Connection protocol: HTTP or HTTPS.
host	Yes	Server address: myhuaweicloud.com.
Parameters for the s3_seagate type (Seagate Lyve Cloud storage):
bucket	Yes	Archive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties.
region	Yes	The region where the corresponding volume is located, as specified when it was created. Corresponds to the Region parameter in the Bucket properties.
access_key_id	Yes	Access key identifier, which is generated when creating an account in the Create Service Account window.
secret_access_key	Yes	Access key password (available after creating an access key).
path	Yes	Location of the folder created inside the bucket.
protocol	Yes	Connection protocol: HTTP or HTTPS.
host	Yes	Server address: lyvecloud.seagate.com.
Parameters for the s3 type:
bucket	Yes	Archive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties.
region	Yes	The region where the volume is located.
access_key_id	Yes	Access key identifier.
secret_access_key	Yes	Access key password (available after creating an access key).
path	No	Location of the Axxon One folder inside the bucket.
protocol	Yes	Connection protocol: HTTP or HTTPS.
host	Yes	Server address.
port	Yes	Server port.

Example of creating an archive volume as files on a local disk:

{
    "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 }
                        ]}]}
        ]
    }
}

Example of creating an archive volume on a network resource:

{
    "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}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating an object archive volume in 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}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating an object archive volume in Amazon 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_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}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating an object archive volume in 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}
                        ]
                    }
                ]
            }
        ]
    }
}

Example of creating an object archive volume in 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}
                        ]
                    }
                ]
            }
        ]
    }
}

Example of creating an object archive volume in 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}
                        ]}]}
        ]
    }
}

Example of creating an object archive volume in 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}
                        ]}
                        ]
            }
        ]
    }
}

Changing an archive volume

To change the archive volume, the same parameters are used as when creating it.

{
    "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": [
                                {
                                }
                            ]
                        }
                    }
                ]
            }
        ]
    }
}

Page tree

Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.

Creating a storage

Creating an archive volume

Changing an archive volume