Estimate Job Progress by Content Size Using REST API
Learn how to use content size to estimate migration job progress using the DryvIQ REST API.
Table of Contents
Overview
The Estimate Content Size feature reports job progress during transfer. This option is defined in your job configuration within the source or destination (sync jobs only) connection.
Options include:
- size_estimate:count
- size_estimate:bytes
Job progress can be monitored using the following endpoint.
GET {{url}}v1/jobs/{{job}}?fields=all
Under execution:progress
Job JSON Count Example
The following example uses 1000 files. When 500 files have been transferred to the destination, the execution progress will report 0.5 or 50%.
{
"name":"Basic Job with Job Progress by Size Estimate Count",
"kind": "transfer",
"transfer": {
"audit_level": "trace",
"transfer_type": "copy",
"source": {
"connection": { "id": "{{nfs_connection}}" },
"size_estimate": {
"count": 1000
},
"target": {
"path": "/sourcePath"
}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/destinationPath"
}
}
},
"schedule": {
"mode": "manual"
}
}
Job JSON Byte Example
The following example uses 1073741824 bytes (1GB). When 536870912 bytes have been transferred to the destination, the execution progress will report 0.5 or 50%.
{
"name":"Basic Job with Job Progress by Size Estimate Bytes",
"kind": "transfer",
"transfer": {
"audit_level": "trace",
"transfer_type": "copy",
"source": {
"connection": { "id": "{{nfs_connection}}" },
"size_estimate": {
"bytes": 1073741824
},
"target": {
"path": "/sourcePath"
}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/destinationPath"
}
}
},
"schedule": {
"mode": "manual"
}
}