...
| 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 archive in Amazon S3 cloud storage (aws.amazon.com/s3), Wasabi (wasabi.com) or Huawei Cloud (huaweicloud.com). |
| 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 (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_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. |
| Parameters for the s3 type (Wasabi storage): |
| bucket | Yes | Archive volume name (Bucket Name), predefined by the user at | storage_class | No | File class in the Amazon S3 interpretation. The default is STANDARD. For the complete list of classes, see https://docsconsole.awswasabisys.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html. |
Example of creating an object archive as files on a local disk:
...
| Code Block |
|---|
{
"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": []
}
} |
#/file_manager. |
| region | Yes | The region where the corresponding volume is located, as specified at https://console.wasabisys.com/#/file_manager. |
| access_key_id | Yes | Access key identifier, which should be pre-created at https://console.wasabisys.com/#/access_keys. |
| 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). |
| host | Yes | Wasabi server address in s3.<region>.wasabisys.com format. |
| Parameters for the s3 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. |
| host | Yes | Server address. Corresponds to the Endpoint parameter in the Bucket properties. |
Example of creating an object archive as files on a local disk:
| Expand |
|---|
|
| Code Block |
|---|
{
"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::
| Expand |
|---|
| Code Block |
|---|
{
"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:
| Expand |
|---|
| Code Block |
|---|
{
"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:
| Expand |
|---|
| Code Block |
|---|
{
"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"
},
{
|
|
Example of creating an object archive on a network resource:
| Expand |
|---|
|
| Code Block |
|---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
"uid": "hosts/Server1/MultimediaStorage.AliceBlue",
"units": [
{
"type": "ArchiveVolume",
"properties": [
"id": "host",
{
"idvalue_string": "connection_params",axxon.s3.amazonaws.com"
"properties": [ }
]
{
},
"id": "schema",
{
"value_stringid": "smblabel",
"value_string": "Test archive"
},
{
"id": "hostvolume_size_gb",
"value_stringuint64": "qa-t39"
4
},
},
{
{
"id": "smb_shareformat",
"value_bool": true
"value_string": "incoming"
},
]
{
}
]
}
"id": "path" ],
"changed": [],
"removed": []
}
} |
|
Example of creating an object archive in Wasabi:
| Expand |
|---|
| Code Block |
|---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"value_stringadded": "video"
[
},{
"uid": "hosts/Server1/MultimediaStorage.Tan",
"units": [
{
{
"idtype": "userArchiveVolume",
"properties": [
"value_string": "QA"
},
{
{"id": "connection_params",
"properties": [
"id": "password",
{
"value_string": "QA_TEST"
}
"id": "schema",
]
},
"value_string": "s3"
{
"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:
| Expand |
|---|
|
| Code Block |
|---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
"uid": "hosts/Server1/MultimediaStorage.AliceBlue",
"units": [
{
"type": "ArchiveVolume",
"properties": [
"id": "bucket",
"value_string": "axxon-wasabi"
},
{
{
"id": "region",
"value_string": "eu-central-1"
"id": "connection_params",
"properties": [ },
{
"id": "schemaaccess_key_id",
"value_string": "azure"
},
{
"id": "protocolsecret_access_key",
"value_string": "https"
},
{
"id": "hostpath",
"value_string": "axxonsoft.blob.core.windows.net13"
},
{
"id": "access_keyprotocol",
"value_string": "bik2582k7wBdpXHtm5WZ7LXvrRM/QGLyuMrzqyNPIRDD+E21yppcBMtiR+FwFFWfYp91aBC6gf1us6Jn3KAhnA==http"
},
{
"id": "containerhost",
"value_string": "container"
},"value_string": "s3.eu-central-1.wasabisys.com"
{}
]
"id": "user",
},
"value_string": "axxonsoft"
{
}"id": "label",
"value_string": "Test archive"
{
},
"id": "path",
{
"value_stringid": "volume_size_gb",
}"value_uint64": 1
},
]
{
},
{
"id": "labelformat",
"value_string": "Test archive"
},
{
"id": "volume_size_gb",
"value_uint64": 10000
},"value_bool": true
{
"id": "format",
"value_bool": true
}
]
}
]
}
],
}
]
}
]
}
],
"changed": [],
"removed": []
}
} |
|
Example of creating an object archive in Amazon S3Huawei Cloud:
| Expand |
|---|
| Code Block |
|---|
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"added": [
{
"uid": "hosts/Server1/MultimediaStorage.AliceBlueGray",
"units": [
{
"type": "ArchiveVolume",
"properties": [
{
"id": "connection_params",
"properties": [
{
"id": "schema",
"value_string": "s3"
},
{
"id": "bucket",
"value_string": "axxontest-infrequent"
},
{
"id": "region",
"value_string": "euna-centralmexico-1"
},
{
"id": "access_key_id",
"value_string": "AGJJFT5P7KU7YO7ZKBBYZSLR77YIR9FOPA2"
},
{
"id": "secret_access_key",
"value_string": "Mfxt/MmGMYYFGR4DO8BHJHUGwa5bU1yQNcHOrmZ3DeZQk9QoklaLNddO0Wav1L1o"
},
{
"id": "path",
"value_string": "test19"
},
{
"id": "protocol",
"value_string": "https"
},
{
"id": "host",
"value_string": "axxon.s3.amazonawsobs.na-mexico-1.myhuaweicloud.com"
}
]
},
{
"id": "label",
"value_string": "Test archive"
},
{
"id": "volume_size_gb",
"value_uint64": 440
},
{
"id": "format",
"value_bool": true
}
]
}
]
}
],
"changed": [],
"removed": []
}
} |
|
...
