View Source

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

uid - Server on which the archive is created;
units - properties;
storage_type - archive type: 0 - old archive type; 1 - 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_gb	Volume size in GB. 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 = 1):
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 - archive in Amazon S3 cloud storage.
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	Location of the volume folder in Azure.
port	No	Azure server port.
Parameters for the s3 type:
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 Next 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 Next 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 Next volume folder inside the bucket.
protocol	Yes	Connection protocol — HTTP or HTTPS.
host	Yes	Amazon S3 server address in <bucket_name>.s3.amazonaws.com format.
storage_class	No	File class in the Amazon S3 interpretation. The default is STANDARD. For the complete list of classes, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html.

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

Example of creating an object archive in Amazon S3:

{
    "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": "s3"
                                    },
                                    {
                                        "id": "bucket",
                                        "value_string": "axxon"
                                    },
                                    {
                                        "id": "region",
                                        "value_string": "eu-central-1"
                                    },
                                    {
                                        "id": "access_key_id",
                                        "value_string": "AGJJFT5P7KU7YO7"
                                    },
                                    {
                                        "id": "secret_access_key",
                                        "value_string": "Mfxt/MmGMYYFGR4DO8BHJHU"
                                    },
                                    {
                                        "id": "path",
                                        "value_string": "test"
                                    },
                                    {
                                        "id": "protocol",
                                        "value_string": "https"
                                    },
                                    {
                                        "id": "host",
                                        "value_string": "axxon.s3.amazonaws.com"
                                    }
                                ]
                            },
                            {
                                "id": "label",
                                "value_string": "Test archive"
                            },
                            {
                                "id": "volume_size_gb",
                                "value_uint64": 4
                            },
                            {
                                "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": []
	}
}