Section |
---|
Column |
---|
|
Panel |
---|
borderColor | #CCCCCC |
---|
bgColor | #FFFFFF |
---|
titleBGColor | #F0F0F0 |
---|
borderStyle | solid |
---|
title | On this page: |
---|
| |
|
|
...
Code Block |
---|
{
"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;
- volumestorage_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.
...
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 archive 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 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 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 |
; − — network archive with an SMB protocol connection |
; − — archive in Microsoft Azure cloud storage |
;− − — archive in Wasabi cloud storage (wasabi.com). s3_huawei |
− − — archive in Seagate Lyve Cloud cloud storage (seagate.com). s3_minio — universal archive in the cloud storage (min.io.com). It is used when using other types of 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 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 |
... |
Parameters for the azure type: |
protocol | Yes | Connection protocol: HTTP or HTTPS. This parameter is located in the properties of the created container |
. server 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 |
. server .. |
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.. |
path | Yes | Location of the Axxon Next volume folder inside the bucket |
. |
protocol | Yes | Connection protocol: HTTP or HTTPS |
..... |
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) |
.. |
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 |
.. |
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 |
..Example of creating an archive volume as files on a local disk:
|
Parameters for the s3_miniotype (MinIO storage): |
bucket | Yes | Archive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties |
bucket_endpoint | No | Domain name with a port. Note |
---|
| The parameter should only be used 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
|
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 Next folder inside the bucket |
protocol | Yes | Connection protocol: HTTP or HTTPS |
host | Yes | Server address |
port | Yes | Server port |
Info |
---|
|
Starting from Аxxon Next 4.6.2.87, it is possible to create multiple volumes of the object archive. |
Example of creating an archive volume as files on a local disk:
Expand |
---|
|
Code Block |
---|
{
"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:
Expand |
---|
|
Code Block |
---|
{
"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:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config. |
|
Expand |
---|
|
Code Block |
---|
{
"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": "fileazure" },
{ "id": "pathprotocol", "value_string": "D:/archiveshttps" },
]}}]},
{ "id": "host", "value_string": "axxonsoft.blob.core.windows.net" },
{"id": "label","value_string": "test"},
{ "id": "volumeaccess_sizekey", "value_uint64string": "26843545600youraccesskey==" },
{"id": "format","value_bool": true},
{ "id": "auto_mountcontainer", "value_boolstring": true"container" },
]}]}
]
}
} |
|
Example of creating an archive volume on a network resource:
Expand |
---|
|
Code Block |
---|
{
{ "methodid": "axxonsoft.bl.config.ConfigurationService.ChangeConfiguser",
"data": {
"value_string": "axxonsoft" },
"added": [
{
"uid": "hosts/SERVER/MultimediaStorage.Gray",
{ "id": "path", "unitsvalue_string": ["" }
{
"type": "ArchiveVolume",
]}}]},
"properties{"id": "label","value_string": ["test"},
{
"id": "volume_size","value_uint64": "12073741824"},
{"id": "volume_type",
format","value_bool": true}
]}
"value_string": "object",
]
"properties": [}
]
}
} |
|
Example of creating an object archive volume in Amazon:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
{
"uid": "hosts/SERVER/MultimediaStorage.Gray",
"idunits": "connection_params",
[
{
"value_properties": {
"type": "ArchiveVolume",
"properties": [
"properties": [
{
{ "id": "schemavolume_type", "value_string": "smb" },
{ "id": "host", "value_string": "computerobject" },
"properties": [
{ "id": "smb_domain", "value_string": "domain" },
{
{ "id": "smb_share", "value_string": "Share" },
{ "id": "pathconnection_params", "value_string": "video" },
{ "id": "user", "value_string": "Tester" },
"value_properties": {
{ "id": "password", "value_string": "Testing321" }
"properties": [
]}}]},
{ "id": "labelschema", "value_string": "tests3_amazon" },
{ "id": "volume_sizebucket", "value_uint64string": "12073741824axxonsoft-test" },
{ {"id": "formatregion", "value_boolstring": true}"us-west-1" },
]}
{ "id": "access_key_id", "value_string": "youraccesskeyid" },
]
{ }
]
}
} |
|
Example of creating an object archive volume in Microsoft Azure:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"id": "secret_access_key", "value_string": "yoursecretaccesskey" },
{ "id": "addedpath", "value_string": ["path" },
{
{ "id": "protocol", "uidvalue_string": "hosts/SERVER/MultimediaStorage.Gray",
https" },
"units": [{ "id": "host", "value_string": "amazonaws.com" }
{
"type": "ArchiveVolume",
]}}]},
"properties{"id": "label","value_string": ["test"},
{
"id": "volume_size","value_uint64": "12073741824"},
{"id": "volume_type",format","value_bool": true}
"value_string": "object",]}
"properties": [
]
}
]
}
} |
|
Example of creating an object archive volume in Wasabi:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
"iduid": "connection_paramshosts/SERVER/MultimediaStorage.Gray",
"units": [
"value_properties": {
"type": "ArchiveVolume",
"properties": [
"properties": [
{
{ "id": "schema", "value_string": "azure" },
"id": "volume_type",
{ "id": "protocol", "value_string": "httpsobject" },
{ "id"properties": "host", "value_string": "axxonsoft.blob.core.windows.net" },
[
{
{ "id": "access_key", "value_string": "youraccesskey==" },
"id": "connection_params",
{ "id": "container", "value_string": "container" },
"value_properties": {
{ "id": "user", "value_stringproperties": "axxonsoft" },[
{ "id": "pathschema", "value_string": "s3_wasabi" },
]}}]},
{{ "id": "labelbucket", "value_string": "testaxxontest-1" },
{ "id": "volume_sizeregion", "value_uint64string": "12073741824us-central-1" },
{"id": "format","value_bool": true}
{ "id": "access_key_id", ]}"value_string": "youraccesskeyid" },
]
}
]
}
} |
|
Example of creating an object archive volume in Amazon S3:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig" { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
"data": {
"added": [
{
{ "id": "uidpath", "value_string": "hosts/SERVER/MultimediaStorage.Gray",
path" },
"units": [
{ {"id": "protocol", "value_string": "http" },
"type": "ArchiveVolume",
{ "propertiesid": [
"host", "value_string": "wasabisys.com" }
{
"id": "volume_type",]}}
"value_string": "object"]},
"properties{"id": "label","value_string": ["test"},
{{"id": "volume_size","value_uint64": "209715200"},
{"id": "format"connection,"value_params",
bool": true}
]
"value_properties": { }
]
}
]
}
} |
|
Example of creating an object archive volume in Huawei Cloud:
Expand |
---|
|
Code Block |
---|
{
"propertiesmethod": ["axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
{ "id": "schema", "value_stringuid": "s3_amazon" }hosts/SERVER/MultimediaStorage.Gray",
"units": [
{ "id": "bucket", "value_string": "axxonsoft-test" },
{ "idtype": "region", "value_string": "us-west-1" }ArchiveVolume",
{ "id": "access_key_id", "value_string": "youraccesskeyid" },properties": [
{ "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
{ "id": "pathvolume_type", "value_string": "path" },
{ "id": "protocol", "value_string": "httpsobject" },
{ "idproperties": "host", "value_string": "amazonaws.com" }
[
{
]}}]},
{"id": "label","value_string": "test"},
connection_params",
{"id": "volume_size","value_uint64": "12073741824"}, "value_properties": {
{"id": "format","value_bool": true}
"properties": [
]}
]
}
{ "id": "schema", "value_string": ]
"s3_huawei" },
}
} |
|
Example of creating an object archive volume in Wasabi:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
{ "id": "bucket", "addedvalue_string": ["axxon-test-1" },
{
{ "id": "region", "uidvalue_string": "hosts/SERVER/MultimediaStorage.Gray"ap-southeast-1" },
"units": [
{ "id": "access_key_id", "value_string": "youraccesskeyid" },
{
{ "typeid": "ArchiveVolumesecret_access_key",
"properties": [ "value_string": "yoursecretaccesskey" },
{
"id": "path", "value_string": "path" },
{ "id": "volume_type"protocol", "value_string": "https" },
{ "id": "host", "value_string": "object",
myhuaweicloud.com" }
"properties": [
]}}]},
{
{"id": "label","value_string": "test"},
{"id": "connection_params""volume_size","value_uint64": "10073741824"},
{"id": "format","value_propertiesbool": {true}
]
"properties": [}
]
}
]
}
} |
|
Example of creating an object archive volume in Seagate Lyve Cloud:
Expand |
---|
|
Code Block |
---|
{
{ "idmethod": "schemaaxxonsoft.bl.config.ConfigurationService.ChangeConfig",
"value_stringdata": "s3_wasabi" },{
"added": [
{
"uid": "hosts/SERVER/MultimediaStorage.Gray",
{ "id": "bucket", "value_stringunits": "axxontest-1" },[
{
{ "idtype": "region", "value_string": "us-central-1" }ArchiveVolume",
"properties": [
{ "id": "access_key_id", "value_string": "youraccesskeyid" },
"id": "volume_type",
{ "id": "secret_access_key", "value_string": "yoursecretaccesskeyobject" },
"properties": [
{ "id": "path", "value_string": "path" },
{
{ "id": "protocol", "value_stringid": "httpconnection_params" },
"value_properties": {
{ "id": "host", "value_string": "wasabisys.com" }
"properties": [
]}}
{ "id": "schema", "value_string": "s3_seagate" ]},
{ "id": "labelbucket", "value_string": "axxonsoft-test" },
{ "id": "volume_sizeregion", "value_uint64string": "209715200us-west-1" },
{ "id": "formataccess_key_id", "value_bool": true}string": "youraccesskeyid" },
]
{ "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
}
]
{ "id": "path", }
"value_string": "path" },
]
}
} |
|
Example of creating an object archive volume in Huawei Cloud:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
{ "id": "protocol", "addedvalue_string": [
"https" },
{
{ "id": "uidhost", "value_string": "hosts/SERVER/MultimediaStorage.Gray",
lyvecloud.seagate.com" }
"units": [
{]}}]},
"type {"id": "label","value_string": "ArchiveVolumetest"},
"properties": [ {"id": "volume_size","value_uint64": "1073741824"},
{
"id": "format","value_bool": true}
"id": "volume_type",]}]}
]
}
} |
|
Example of creating an object archive volume in MinIO S3:
Expand |
---|
|
Code Block |
---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"value_string": "object",
"added": [
{
"propertiesuid": ["hosts/ServerName/MultimediaStorage.Gray",
"units": [
{
"type": "ArchiveVolume",
"id": "connection_params",
"properties": [
{
"value_properties": {
"id": "volume_type",
"properties": [
"value_string": "object",
{ "idproperties": "schema", "value_string": "s3_huawei" },
[
{ "id": "bucket", "value_string": "axxon-test-1" },
{ "id": "regionconnection_params", "value_string": "ap-southeast-1" },
{ "id": "access_key_id", "value_stringproperties": "youraccesskeyid" },{
{ "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
"properties": [
{ "id": "path", "value_string": "path" },
{ "id": "protocolschema", "value_string": "httpss3" },
{ "id": "host", "value_string": "myhuaweicloud.com" }
{ "id": "bucket", "value_string": "bucket" },
]}}]},
{ {"id": "labelregion", "value_string": "testus-east-1" },
{"id": "volume_size","value_uint64": "10073741824"},
{ "id": "formataccess_key_id", "value_boolstring": true"MINIOROOT" },
]
{ "id": "secret_access_key", "value_string": "MINIOPASS" },
]
}
]
}
} |
|
Example of creating an object archive volume in Seagate Lyve Cloud:
Expand |
---|
|
Code Block |
---|
{
"id": "path", "methodvalue_string": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
path" },
"data": {
"added": [
{
{ "uidid": "hosts/SERVER/MultimediaStorage.Gray",
protocol", "value_string": "http" },
"units": [
{
{ "id": "host", "value_string": "192.168.56.102" },
"type": "ArchiveVolume",
"properties": [
{ "id": "port", "value_string": "9000" }
{
"id": "volume_type"]}}]},
{"id": "label","value_string": "objecttest"},
"properties{"id": "volume_size","value_uint64": [1207374182},
{"id": {"format","value_bool": true}
]}
"id": "connection_params",
]
}
]
}
} |
|
Example of creating an object archive volume in MinIO S3 using the domain name:
Expand |
---|
|
Code Block |
---|
{
"value_propertiesmethod": {"axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
"propertiesuid": ["hosts/Server/MultimediaStorage.Gray",
"units": [
{
{ "id": "schema", "value_string": "s3_seagate" },
"type": "ArchiveVolume",
{ "id": "bucket", "value_stringproperties": "axxonsoft-test" },[
{
"id": "region", "value_string": "us-west-1" },
{ "id": "accessvolume_key_idtype",
"value_string": "youraccesskeyid" },
{ "id": "secret_access_key", "value_string": "yoursecretaccesskeyobject" },
"properties": [
{ "id": "path", "value_string": "path" },
{
{ "id": "protocol", "value_string": "https" },
{ "id": "hostconnection_params",
"value_string": "lyvecloud.seagate.com" }
"value_properties": {
]}}]},
{"id": "label","value_string": "test"},
"properties": [
{"id": "volume_size","value_uint64": "1073741824"},
{ "id": "formatschema", "value_boolstring": true"s3" },
]}]}
]
}
} |
|
Example of creating an object archive volume in MinIO S3:
Expand |
---|
|
Code Block |
---|
{
{ "methodid": "axxonsoft.bl.config.ConfigurationService.ChangeConfigbucket",
"data": {
"value_string": "bucket" },
"added": [
{
"uid": "hosts/{{ServerName}}/MultimediaStorage.{{ArchiveColor}}",
{ "id": "region", "unitsvalue_string": [
"us-east-1" },
{
{ "typeid": "ArchiveVolumeaccess_key_id",
"value_string": "MINIOROOT" },
"properties": [
{
"id": "secret_access_key", "value_string": "MINIOPASS" },
"id": "volume_type",
{ "id": "path", "value_string": "object" },
"properties": [
{ "id": "protocol", "value_string": "http" },
{
{ "id"id": "host", "value_string": "connection_params" },
{ "value_properties": {"id": "bucket_endpoint", "value_string": "http://miniopoc1.agis.xh.ar:9000" }
"properties": [
]}}]},
{ "id": "schemalabel", "value_string": "s3test" },
{ "id": "bucketvolume_size", "value_stringuint64": "bucket" 1207374182},
{"id": "format","value_bool": true}
{ "id": "region", "value_string": "us-east-1" }, ]}
]
}
]
}
} |
|
Changing an archive volume
To change the archive volume, the same parameters are used as when creating it.
Code Block |
---|
Code Block |
---|
{
" idmethod": " access_key_idaxxonsoft.bl.config.ConfigurationService.ChangeConfig",
"value_string "data": "youraccesskeyid" },{
"changed": [
{
"uid": "hosts/Server/MultimediaStorage.Gray/ArchiveVolume.4508f459-5eeb-4ee3-881b-4a4e149c7802",
{ " idproperties": "secret_access_key", "value_string": "yoursecretaccesskey" },[
{
{ "id": " pathlabel", "value_string": "path" },
"value_string": "NewLabel"
},
{ "id": "protocol", "value_string": "http" },
{
"id": "readonly",
{ "id": "host", "value_string": ".com" },
"value_bool": false
},
{
"id": "port", "value_string": "port" }
"id": "connection_params",
]}}]},"value_properties": {
{" idproperties": "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.archive.ArchiveService.Resize",
"data":
{
]
"access_point": "MultimediaStorage.Gray/MultimediaStorage",
"volume_id": "4508f459-5eeb-4ee3-881b-4a4e149c7802", }
"new_size": 307374182]
}
} |