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

Previous page Get archive history using gRPC API methods (ArchiveService)  Link camera to archive using gRPC API methods Next page

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;
  • storage_type—archive type (if the parameter isn't explicitly specified, then an archive of the old type is created): 
    • block—old archive type,
    • object—new archive type (object archive). 

Creating an archive volume

Possible ArchiveVolume parameters in the properties section:

ParameterDescription
formattrue if it is necessary to format the created volume. The default value is false
volume_sizeVolume size in bytes. Applicable if format = true
auto_mounttrue if it is necessary to mount the created volume. The default value is false
labelVolume label
Parameters for object archive only (storage_type = object):
max_block_size_mbMaximum block size in MB. The default value is 64, the range of valid values is [16; 512]
optimal_read_size_mbOptimal size of blocks reading in MB. The default value is 4, the range of valid values is [1; max_block_size_mb / 2]
incoming_buffer_size_mbThe incoming buffer size in MB. The default value is 3 * max_block_size_mb. The minimum value must be greater than 2 * max_block_size_mb
block_flush_period_secondsBlock recording period in seconds. The default value is 60, the range of valid values is [30; 300]
index_snapshot_max_block_distanceThe maximum number of blocks between indexing operations. The default value is 256, the minimum value is 16
sequence_flush_period_secondsFrequency of recording sequences in seconds. The default value is 60, the minimum value is 32

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

ParameterRequiredDescription
schema Yes

Volume type. Possible values:

  • file—local archive on the server,
  • smb—remote archive with SMB protocol connection,
  • azure—archive in Microsoft Azure cloud storage (azure.microsoft.com),
  • s3_amazon—archive in Amazon S3 cloud storage (aws.amazon.com),
  • s3_seagate—archive in Seagate Lyve Cloud cloud storage (www.seagate.com),
  • s3_wasabi—archive in Wasabi cloud storage (wasabi.com),
  • s3—universal archive in the cloud storage (AxxonSoft tested it with min.io.com version RELEASE.2021-08-05T22-01-19Z). It is used when using other types of cloud storage
Parameters for the file type
pathYesThe path to the file/disk with the archive
Parameters for the smb type
hostYesName of the server with remote storage
smb_shareYesRemote storage
pathYesFolder in remote storage, where the archive are stored
smb_domainNoRemote storage domain
userNoUsername
passwordNoPassword
Parameters for the azure type (Microsoft Azure storage)
protocol Yes

Connection protocol: HTTP or HTTPS. This parameter is located in the properties of the created container

hostYes

Azure server address. This parameter is located in the properties of the created container

access_keyYes

Access key in base64. This parameter is located in the Access keys section

containerYes

Azure container. This parameter is located in the properties of the created container

userYes

Username. This parameter is located in the Access keys section (Storage account name)

pathNo

Do not specify the location of the volume folder in Azure—the parameter must be empty

portNoAzure 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_keyYes

Access key password (available after creating an access key)

bucketYes

Archive volume in Amazon S3 account (bucket). Different volumes can be located in different regions. On the Amazon S3 server, the volume name must be unique, and for the Axxon One operation, it must be pre-created by the user according to the rules (see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)

regionYes

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

pathYesLocation of the Axxon One volume folder inside the bucket
protocolYesConnection protocol: HTTP or HTTPS
hostYes

Server address: amazonaws.com

Parameters for the s3_wasabi type (Wasabi storage)
bucketYes

Archive volume name (Bucket Name), predefined by the user at https://console.wasabisys.com/#/file_manager

regionYes

The region where the corresponding volume is located, as specified at https://console.wasabisys.com/#/file_manager

access_key_idYes

Access key identifier, which must be pre-created at https://console.wasabisys.com/#/access_keys

secret_access_keyYesAccess key password (available after creating an access key)
protocolYesConnection protocol: HTTP or HTTPS
pathYes

Location of the folder created inside the bucket (Folder object in Bucket)

hostYes

Server address: wasabisys.com

Parameters for the s3_seagate type (Seagate Lyve Cloud storage):
bucketYesArchive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties
regionYesThe region where the corresponding volume is located, as specified when it was created. Corresponds to the Region parameter in the Bucket properties
access_key_idYes

Access key identifier, which is generated when creating an account in the Create Service Account window

secret_access_keyYesAccess key password (available after creating an access key)
pathYesLocation of the folder created inside the bucket
protocolYesConnection protocol: HTTP or HTTPS
hostYes

Server address: lyvecloud.seagate.com

Parameters for the s3 type
bucketYesArchive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties
bucket_endpointNo

Domain name with a port.

Attention!

You must use the parameter only when using MinIO if the domain name of the MinIO server is specified instead of the server IP address.

Example: http://miniopoc1.agis.xh.ar:9000

where,

  • miniopoc1.agis.xh.ar—the domain name of the MinIO server,
  • 9000—MinIO port
regionYesThe region where the volume is located
access_key_idYes

Access key identifier

secret_access_keyYesAccess key password (available after creating an access key)
pathNoLocation of the Axxon One folder inside the bucket
protocolYesConnection protocol: HTTP or HTTPS
hostYes

Server address

portYesServer port

Note

Starting with Аxxon One 2.0, you can create several volumes of the cloud archive.

Attention!

  • We recommend adding new volumes of the cloud archive with the same value of archive size. Otherwise, the total depth of the archive storage can change due to the Round-robin algorithm (see General information about the Round-robin algorithm) for record distribution, which can lead to decimation of the frames of archive recordings.

  • When the archive size of one of the cloud archive volumes increases, the archive volumes are overwritten by the Round-robin algorithm (see General information about the Round-robin algorithm). The depth of the archive storage will gradually increase over the number of days equal to the difference between the original and the new value of the archive storage depth.

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 remote 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 a cloud 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 a cloud archive volume in 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}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating a cloud 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 a cloud 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 a cloud 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}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating a cloud archive volume in MinIO S3 using the domain name

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

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

 

  • No labels