Creating an archive entity

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/Server1",
                "units": [
                    {
                        "type": "MultimediaStorage",
                        "properties": [
                            {
                                "id": "display_name",
                                "properties": [],
                                "value_string": "Object storage"
                            },
                            {
                                "id": "color",
                                "properties": [],
                                "value_string": "AliceBlue"
                            },
                            {
                                "id": "storage_type",
                                "value_int32": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "changed": [],
        "removed": []
    }
}

where

Creating an archive volume

Possible ArchiveVolume parameters in the properties section:

ParameterDescription
formattrue if it is necessary to format the created volume. The default is false.
volume_size_gbVolume size in GB. Applicable if format = true.
auto_mounttrue if it is necessary to mount the created volume. The default is false.
labelVolume label
Parameters for object archives only (storage_type = 1):
max_block_size_mbMaximum block size in MB. The default is 64, the range of valid values is [16; 512].
optimal_read_size_mbOptimal 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_mbThe 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_secondsBlock recording period in seconds. The default is 60, the range of valid values is [30; 300].
index_snapshot_max_block_distanceThe maximum number of blocks between indexing operations. The default is 256, the minimum is 16.
sequence_flush_period_secondsSequences 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:

ParameterRequiredDescription
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.

Parameters for the file type:
pathYesThe path to the file/disk with the archive.
Parameters for the smb type:
hostYesName of the server with network repository.
smb_shareYesNetwork repository.
pathYesFolder in network repository, where the archive will be stored.
smb_domainNoNetwork repository domain.
userNoUser name.
passwordNoPassword.
Parameters for the azure type:
protocol YesConnection protocol: HTTP or HTTPS.
hostYesAzure server address.
access_keyYesAccess key in base64.
containerYesAzure container.
userYesUser name.
pathNoLocation of the volume folder in Azure.
portNoAzure server port.

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


{
	"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
	"data": {
		"added": [
			{
				"uid": "hosts/Server1/MultimediaStorage.AliceBlue",
				"units": [
					{
						"type": "ArchiveVolume",
						"properties": [
							{
								"id": "connection_params",
								"properties": [
									{
										"id": "schema",
										"value_string": "file"
									},
									{
										"id": "path",
										"value_string": "D:/archiveCrimson1"
									}
								]
							},
							{
								"id": "label",
								"value_string": "Test archive"
							},
							{
								"id": "volume_size_gb",
								"value_uint64": 4
							}
						]
					}
				]
			}
		],
		"changed": [],
		"removed": []
	}
}


Example of creating an object archive on a network resource:


{
	"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
	"data": {
		"added": [
			{
				"uid": "hosts/Server1/MultimediaStorage.AliceBlue",
				"units": [
					{
						"type": "ArchiveVolume",
						"properties": [

                            {
                                "id": "connection_params",
                                "properties": [
                                    {
                                        "id": "schema",
                                        "value_string": "smb"
                                    },
                                    {
                                        "id": "host",
                                        "value_string": "qa-t39"
							        },
                                    {
                                        "id": "smb_share",
                                        "value_string": "incoming"
							        },
                                    {
                                        "id": "path",
                                        "value_string": "video"
							        },
                                    {
                                        "id": "user",
                                        "value_string": "QA"
							        },
                                    {
                                        "id": "password",
                                        "value_string": "QA_TEST"
							        }
                                ]
                            },

                            {
								"id": "label",
							    "value_string": "Test archive"
							},
                            {
								"id": "volume_size_gb",
								"value_uint64": 4
							},
                            {
								"id": "format",
								"value_bool": true
							}
						]
					}
				]
			}
		],
		"changed": [],
		"removed": []
	}
}


Example of creating an object archive in Microsoft Azure:



{
	"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
	"data": {
		"added": [
			{
				"uid": "hosts/Server1/MultimediaStorage.AliceBlue",
				"units": [
					{
						"type": "ArchiveVolume",
						"properties": [

                            {
                                "id": "connection_params",
                                "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": "bik2582k7wBdpXHtm5WZ7LXvrRM/QGLyuMrzqyNPIRDD+E21yppcBMtiR+FwFFWfYp91aBC6gf1us6Jn3KAhnA=="
                                    },
                                    {
                                        "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": 10000
							},
                            {
								"id": "format",
								"value_bool": true
							}
						]
					}
				]
			}
		],
		"changed": [],
		"removed": []
	}
}


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": {
		"added": [],
		"changed": [
			{
				"uid": "hosts/Node1/MultimediaStorage.AliceBlue/ArchiveVolume.d0305f4a-1a20-4b10-a132-605eff3269d7",
				"properties": [
					{
						"id": "connection_params",
						"properties": [
							{
								"id": "schema",
								"value_string": "file"
							},
							{
								"id": "path",
								"value_string": "D:/archiveCrimson11"
							}
						]
					}
				]
			}
		],
		"removed": []
	}
}