Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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;

s3 - archive in Amazon S3 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 Yes

Connection protocol: HTTP or HTTPS.

This parameter is located in the properties of the created container.

hostYes

Azure server address.

This parameter is located in the properties of the created container.

access_keyYes

Access key in base64.

This parameter is located in the Access keys section.

containerYes

Azure container.

This parameter is located in the properties of the created container.

userYes

User name.

This parameter is located in the Access keys section (Storage account name).

pathNoLocation of the volume folder in Azure.
portNoAzure server port.

...

Expand
titleClick to 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"
                                    },
                                    {
                                        "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

...