StartBulkVolumeWrite
Suggest changes
PDFs
You can use the StartBulkVolumeWrite method to start a bulk volume write session on a specified volume.
Only two bulk volume processes can run simultaneously on a volume. When you initialize the session, data is written to an Element storage volume from an external backup source. The external data is accessed by a web server running on an Element storage node. Server interaction information for external data access is passed by a script running on the storage system.
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
format |
The format of the volume data. Can be either:
|
string |
None |
Yes |
volumeID |
The ID of the volume to be written to. |
integer |
None |
Yes |
script |
The name of an executable script. If no script name is given, the key and URL are necessary to access Element storage nodes. The script is run on the primary node, and the key and URL are returned to the script so the local web server can be contacted. |
string |
None |
No |
scriptParameters |
JSON parameters to pass to the script. |
JSON object |
None |
No |
attributes |
List of name-value pairs in the JSON object format. Learn more. |
JSON object |
None |
No |
Return values
This method has the following return values:
Name |
Description |
Type |
asyncHandle |
The ID of the asynchronous process to be checked for completion. |
integer |
key |
Opaque key uniquely identifying the session. |
string |
url |
URL to access the node's web server. |
string |
Request example
Requests for this method are similar to the following example:
{
"method": "StartBulkVolumeWrite",
"params": {
"volumeID" : 5,
"format" : "native",
},
"id": 1
}
Response example
This method returns a response similar to the following example:
{
"id" : 1,
"result" : {
"asyncHandle" : 1,
"key" : "11eed8f086539205beeaadd981aad130",
"url" : "https://127.0.0.1:44000/"
}
}
New since version
9.6