Go to documentation repository
Documentation for Axxon Next 4.6.0. Documentation for other versions of Axxon Next is available too.
Previous page Next page
On this page:
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 - standard archive; 1 - cloud archive. If the parameter is not explicitly specified, then a standard archive 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 |
| 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. |
| 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. |
| host | Yes | Azure server address. |
| access_key | Yes | Access key in base64. |
| container | Yes | Azure container. |
| user | Yes | User name. |
| path | No | Location of the volume folder in Azure. |
| port | No | Azure server port. |
{
"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": []
}
}
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": []
}
}
Overview
Content Tools